X-Git-Url: https://jxself.org/git/?p=open-adventure.git;a=blobdiff_plain;f=INSTALL.adoc;h=e60fc15bd1fd347d9ac5ce065a44a813593dd634;hp=9806f2fbe1b4a6b81614be47839e8d8a1034bf7c;hb=baa7800a3f6f7a768a3e16a86dd951424df31acb;hpb=a727aebdfa8b067de642f9bfc17cf581d1682487 diff --git a/INSTALL.adoc b/INSTALL.adoc index 9806f2f..e60fc15 100644 --- a/INSTALL.adoc +++ b/INSTALL.adoc @@ -1,14 +1,18 @@ = Installing Open Adventure = -The instructions below assume your system uses Python 3 by default, but the actual Python code in Open Adventure is 2/3-agnostic. Adjust the example commands below accordingly. +The instructions below assume your system uses Python 3 by default, +but the actual Python code in Open Adventure is 2/3-agnostic. Adjust +the example commands below accordingly. -1. Install PyYAML for Python 3 (which requires Python 3) and libedit from http://thrysoee.dk/editline/ (aka: editline) on your system. +1. Install PyYAML for Python 3 (which requires Python 3) and libedit +from http://thrysoee.dk/editline/ (aka: editline) on your system. + On Debian and Ubuntu: `apt-get install python3-yaml libedit-dev`. + On Fedora: `dnf install python3-PyYAML libedit-devel`. + -If you are using MacPorts on OS X: `port install py3{5,6}-yaml`, as appropriate for your Python 3 version. +If you are using MacPorts on OS X: `port install py3{5,6}-yaml`, as +appropriate for your Python 3 version. + You can also use pip to install PyYAML: `pip3 install PyYAML`. @@ -25,7 +29,17 @@ Traceback (most recent call last): ImportError: No module named yaml ------------------------------------------------ + -try editing make_dungeon.py to change `+#!/usr/bin/env python+` to read `+#!/usr/bin/env python3+` +try editing make_dungeon.py to change `#!/usr/bin/env python` to +read `#!/usr/bin/env python3` ++ +If you still get the error, use the following command to install yaml with pip: ++ +------------------------------------------------ +pip install pyyaml +------------------------------------------------ ++ +Make sure you have `pip` installed on your system. If not, you should +install it first. See https://pip.pypa.io/en/stable/installing/ 4. Optionally run a regression test on the code with `make check`.