X-Git-Url: https://jxself.org/git/?p=open-adventure.git;a=blobdiff_plain;f=INSTALL.adoc;h=e60fc15bd1fd347d9ac5ce065a44a813593dd634;hp=747324743cb5027b2cb6b00cd705b01c7997175a;hb=HEAD;hpb=8207199a33c6f785172a27646336c79aaaf2f7ff diff --git a/INSTALL.adoc b/INSTALL.adoc index 7473247..5184d6b 100644 --- a/INSTALL.adoc +++ b/INSTALL.adoc @@ -1,29 +1,25 @@ = Installing Open Adventure = +// SPDX-FileCopyrightText: (C) Eric S. Raymond +// SPDX-License-Identifier: CC-BY-4.0 -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. +Installation now requires Python3 due to a security issue +with the YAML library. -1. Install PyYAML for Python 3 (which requires Python 3) and libedit -from http://thrysoee.dk/editline/ (aka: editline) on your system. +1. Install libedit from http://thrysoee.dk/editline/ (aka: editline) +on your system. ++ +On Debian and Ubuntu: `apt-get install libedit-dev`. ++ +On Fedora: `dnf install libedit-devel`. ++ +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'. +2. Change to the top-level directory of the source code (e.g., `cd open-adventure`). -If you are using MacPorts on OS X: 'port install py3{5,6}-yaml', as -appropriate for your Python 3 version. +3. Build with `make`. -You can also use pip to install PyYAML: 'pip3 install PyYAML'. +4. Optionally run a regression test on the code with `make check`. -2. 'make'. +5. Run `./advent` to play. -3. Optionally run a regression test on the code with 'make check'. - -4. Run the resulting 'advent' binary to play. - -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 +6. If you want to buld the documentation you will need asciidoctor.