archives/open-adventure
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Move most build instructions into INSTALL.adoc.

Browse source
This commit is contained in:
Jason S. Ninneman 2017-07-01 07:14:27 -07:00
parent c69355f08a
commit 5fcebc66ae
3 changed files with 21 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

17
INSTALL.adoc Normal file
View file

@ -0,0 +1,17 @@
= Installing Open Adventure =
1. Install PyYAML for Python 3 (which requires Python 3), and libedit
(aka: editline) on your system.
On Debian and Ubuntu: 'apt-get install python3-yaml 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.
You can also use pip to install PyYAML: 'pip3 install PyYAML'.
2. 'make'.
3. Optionally run a regression test on the code with 'make check'.
4. Run the resulting 'advent' binary to play.

16
Makefile
View file

@ -1,21 +1,5 @@
# Makefile for the open-source release of adventure 2.5
# The libedit (aka: editline) library is required to build. On
# Debian or Ubuntu:
#
# apt-get install libedit-dev
# You will also need Python 3 YAML. Under Debian or ubuntu:
#
# apt-get install python3-yaml
#
# If you have pip installed,
#
# pip3 install PyYAML
#
# If you are using MacPorts on OS X:
# port install py3{5,6}-yaml as appropriate for your Python 3 version.
#
# To build with save/resume disabled, pass CCFLAGS="-D ADVENT_NOSAVE"
VERS=$(shell sed -n <NEWS '/^[0-9]/s/:.*//p' | head -1)

10
README.adoc
View file

@ -16,13 +16,11 @@ original 6-character name on the PDP-10 has been reverted to for the
executable in order to avoid a collision with the BSD games port of
the ancestral 1977 version.
The distribution has three build-time dependencies: Python 3, Python 3
YAML, and libedit. It builds a pure C executable.
Please see INSTALL.adoc for build info.
You can run a regression test on the code with 'make check'. Extreme
care has been taken to not silently change gameplay. By policy, all
user-visible changes from 2.5 are revertible with the -o (oldstyle)
option.
Extreme care has been taken to not silently change gameplay. By
policy, all user-visible changes from 2.5 are revertible with the
-o (oldstyle) option.
If you encounter a bug (not likely; this code is old and well tested)
please try to make a test log that reproduces it, using the -l option,