Fix markup.

[open-adventure.git] / INSTALL.adoc

diff --git a/INSTALL.adoc b/INSTALL.adoc
index 803a644ad90b5cfd163c90278e2fb58615ffa270..e60fc15bd1fd347d9ac5ce065a44a813593dd634 100644 (file)
--- a/INSTALL.adoc
+++ b/INSTALL.adoc
@@ -1,17 +1,46 @@
 = 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 <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`
++
+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/
 
-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.