archives/open-adventure
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve INSTALL.adoc's directions and asciidoc-ness.

Browse source 
View it in the Gitlab web interface to see the intended result.
This commit is contained in:
Jason Ninneman 2019-02-27 18:06:39 -07:00 • committed by Eric S. Raymond
parent 83f432780a
commit a727aebdfa
1 changed files with 24 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

45
INSTALL.adoc
View file

@ -1,29 +1,32 @@
= 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.
+
You can also use pip to install PyYAML: `pip3 install PyYAML`.
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.
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 <module>
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+`
./make_dungeon.py Traceback (most recent call last): File "./make_dungeon.py", line 10, in import sys, yaml ImportError: No module named yaml
4. Optionally run a regression test on the code with `make check`.
try editing make_dungeon.py to change #!/usr/bin/env python to read
#!/usr/bin/env python3
5. Run `./advent` to play.