X-Git-Url: https://jxself.org/git/?p=open-adventure.git;a=blobdiff_plain;f=INSTALL.adoc;h=9806f2fbe1b4a6b81614be47839e8d8a1034bf7c;hp=803a644ad90b5cfd163c90278e2fb58615ffa270;hb=a727aebdfa8b067de642f9bfc17cf581d1682487;hpb=5fcebc66aeca21c67a8187c462d9091a18121363 diff --git a/INSTALL.adoc b/INSTALL.adoc index 803a644..9806f2f 100644 --- a/INSTALL.adoc +++ b/INSTALL.adoc @@ -1,17 +1,32 @@ = Installing Open Adventure = -1. Install PyYAML for Python 3 (which requires Python 3), and libedit -(aka: editline) on your system. +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. -On Debian and Ubuntu: 'apt-get install python3-yaml libedit-dev'. -On Fedora: 'dnf install python3-PyYAML libedit-devel'. +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`. -If you are using MacPorts on OS X: 'port install py3{5,6}-yaml', as appropriate for your Python 3 version. +2. Change to the top-level directory of the source code (e.g., `cd open-adventure`). -You can also use pip to install PyYAML: 'pip3 install PyYAML'. +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+` -2. 'make'. +4. Optionally run a regression test on the code with `make check`. -3. Optionally run a regression test on the code with 'make check'. - -4. Run the resulting 'advent' binary to play. +5. Run `./advent` to play.