X-Git-Url: https://jxself.org/git/?p=open-adventure.git;a=blobdiff_plain;f=INSTALL.adoc;h=e60fc15bd1fd347d9ac5ce065a44a813593dd634;hp=3e733f34cc61270ab8658a596da2a16db2246dd1;hb=HEAD;hpb=9355882cac573b32e6223f0f08fb2dfe08f70e43 diff --git a/INSTALL.adoc b/INSTALL.adoc index 3e733f3..5184d6b 100644 --- a/INSTALL.adoc +++ b/INSTALL.adoc @@ -1,18 +1,25 @@ = Installing Open Adventure = +// SPDX-FileCopyrightText: (C) Eric S. Raymond +// SPDX-License-Identifier: CC-BY-4.0 -1. Install PyYAML for Python 3 (which requires Python 3), and libedit -(aka: editline) on your system. +Installation now requires Python3 due to a security issue +with the YAML library. -On Debian and Ubuntu: 'apt-get install python3-yaml libedit-dev'. -On Fedora: 'dnf install python3-PyYAML libedit-devel'. +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`. -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`. -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'. +5. Run `./advent` to play. -4. Run the resulting 'advent' binary to play. +6. If you want to buld the documentation you will need asciidoctor.