Test coverage - Almost all of score.c
[open-adventure.git] / README.adoc
1 = README for Open Adventure =
2
3 This code is a forward-port of the Crowther/Woods Adventure 2.5 from
4 1995, last version in the main line of Colossal Cave Adventure
5 development written by the original authors.  The authors have given
6 permission and encouragement for this release.
7
8 The file history.adoc contains a more detailed history of this game
9 and its ancestors.  The file notes.adoc is the maintainer's notes,
10 describing project goals and recent changes.
11
12 This project is called "Open Adventure" because it's not at all clear
13 how to number Adventure past 2.5 without misleading or causing
14 collisions or both.  See the history file for discussion.  The
15 original 6-character name on the PDP-10 has been reverted to for the
16 executable in order to avoid a collision with the BSD games port of
17 the ancestral 1977 version.
18
19 The distribution has three build-time depedencies: Python 3, Python 3
20 YAML, and the linenoise library.  It builds a pure C executable.
21
22 You can run a regression test on the code with 'make check'. Extreme
23 care has been taken to not silently change gameplay. By policy, all
24 user-visible changes from 2.5 are revertible with the -o (oldstyle)
25 option.
26
27 If you encounter a bug (not likely; this code is old and well tested)
28 please try to make a test log that reproduces it, using the -l option,
29 and ship it to the maintainers.
30
31 // end
32
33
34