Move most build instructions into INSTALL.adoc.
[open-adventure.git] / INSTALL.adoc
1 = Installing Open Adventure =
2
3 1. Install PyYAML for Python 3 (which requires Python 3), and libedit
4 (aka: editline) on your system.
5
6 On Debian and Ubuntu: 'apt-get install python3-yaml libedit-dev'.
7 On Fedora: 'dnf install python3-PyYAML libedit-devel'.
8
9 If you are using MacPorts on OS X: 'port install py3{5,6}-yaml', as appropriate for your Python 3 version.
10
11 You can also use pip to install PyYAML: 'pip3 install PyYAML'.
12
13 2. 'make'.
14
15 3. Optionally run a regression test on the code with 'make check'.
16
17 4. Run the resulting 'advent' binary to play.