X-Git-Url: https://jxself.org/git/?p=open-adventure.git;a=blobdiff_plain;f=INSTALL.adoc;h=dc2fa2b45fd1196a64420422278cbca9db0f4e23;hp=c862b0b089b4ee0bc39d7368a245bd728b3054e8;hb=9cbea5a5dbca1596f80ce6055bb3d72d1b0bf85d;hpb=b8dd0eb90412fe7cb062ae8838baf10446e16794 diff --git a/INSTALL.adoc b/INSTALL.adoc index c862b0b..dc2fa2b 100644 --- a/INSTALL.adoc +++ b/INSTALL.adoc @@ -1,22 +1,37 @@ = 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 +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 -(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 +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. - -You can also use pip to install PyYAML: 'pip3 install PyYAML'. - -2. 'make'. - -3. Optionally run a regression test on the code with 'make check'. - -4. Run the resulting 'advent' binary to play. ++ +You can also use pip to install PyYAML: `pip3 install PyYAML`. + +2. Change to the top-level directory of the source code (e.g., `cd open-adventure`). + +3. Build with `make`. ++ +If make returns the following message: ++ +------------------------------------------------ +Traceback (most recent call last): + File "./make_dungeon.py", line 13, in + import sys, yaml +ImportError: No module named yaml +------------------------------------------------ ++ +try editing make_dungeon.py to change `#!/usr/bin/env python` to +read `#!/usr/bin/env python3` + +4. Optionally run a regression test on the code with `make check`. + +5. Run `./advent` to play.