From: Jason Ninneman <jsn@mbar.us>
Date: Thu, 28 Feb 2019 01:06:39 +0000 (-0700)
Subject: Improve INSTALL.adoc's directions and asciidoc-ness.
X-Git-Tag: 1.8~22
X-Git-Url: https://jxself.org/git/?a=commitdiff_plain;h=a727aebdfa8b067de642f9bfc17cf581d1682487;p=open-adventure.git

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

View it in the Gitlab web interface to see the intended result.
---

diff --git a/INSTALL.adoc b/INSTALL.adoc
index 7473247..9806f2f 100644
--- a/INSTALL.adoc
+++ b/INSTALL.adoc
@@ -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.
-
-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.
-
+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.
++
+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. 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:
-
-./make_dungeon.py Traceback (most recent call last): File "./make_dungeon.py", line 10, 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
++
+------------------------------------------------
+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+` 
+
+4. Optionally run a regression test on the code with `make check`.
+
+5. Run `./advent` to play.