INSTALL.adoc

   1 = Installing Open Adventure =
   2 // SPDX-FileCopyrightText: (C) Eric S. Raymond <esr@thyrsus.com>
   3 // SPDX-License-Identifier: CC-BY-4.0
   4
   5 Installation now requires Python3 due to a security issue
   6 with the YAML library.
   7
   8 1. Install libedit from http://thrysoee.dk/editline/ (aka: editline)
   9 on your system.
  10 +
  11 On Debian and Ubuntu: `apt-get install libedit-dev`.
  12 +
  13 On Fedora: `dnf install libedit-devel`.
  14 +
  15 You can also use pip to install PyYAML: `pip3 install PyYAML`.
  16
  17 2. Change to the top-level directory of the source code (e.g., `cd open-adventure`).
  18
  19 3. Build with `make`.
  20
  21 4. Optionally run a regression test on the code with `make check`.
  22
  23 5. Run `./advent` to play.
  24
  25 6. If you want to buld the documentation you will need asciidoctor.