X-Git-Url: https://jxself.org/git/?p=open-adventure.git;a=blobdiff_plain;f=INSTALL.adoc;h=5184d6bc1201fc14a14b728ff4c3d00a7b408a50;hp=9806f2fbe1b4a6b81614be47839e8d8a1034bf7c;hb=HEAD;hpb=a727aebdfa8b067de642f9bfc17cf581d1682487 diff --git a/INSTALL.adoc b/INSTALL.adoc index 9806f2f..5184d6b 100644 --- a/INSTALL.adoc +++ b/INSTALL.adoc @@ -1,32 +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 python3-yaml libedit-dev`. +On Debian and Ubuntu: `apt-get install 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. +On Fedora: `dnf install libedit-devel`. + 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: -+ ------------------------------------------------- -Traceback (most recent call last): - File "./make_dungeon.py", line 13, 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+` 4. Optionally run a regression test on the code with `make check`. 5. Run `./advent` to play. + +6. If you want to buld the documentation you will need asciidoctor.