X-Git-Url: https://jxself.org/git/?p=open-adventure.git;a=blobdiff_plain;f=README.adoc;h=6fd1b4eb4ba3ec43b076116913df1052706950a9;hp=3426278d2dbed0704b0ab9ba90ef20834bcb2752;hb=1e643da216737e148839f463c10594bbb8ac246b;hpb=3f5970893328894910e3d023b42acec975831f63 diff --git a/README.adoc b/README.adoc index 3426278..6fd1b4e 100644 --- a/README.adoc +++ b/README.adoc @@ -5,8 +5,9 @@ This code is a forward-port of the Crowther/Woods Adventure 2.5 from development written by the original authors. The authors have given permission and encouragement for this release. -The file history.txt contains a more detailed history of this game -and its ancestors. +The file history.adoc contains a more detailed history of this game +and its ancestors. The file notes.adoc is the maintainer's notes, +describing project goals and recent changes. This project is called "Open Adventure" because it's not at all clear how to number Adventure past 2.5 without misleading or causing @@ -15,5 +16,19 @@ 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. -You can run a regression test on the code with 'make check'. +The distribution has three build-time depedencies: Python 3, Python 3 +YAML, and the linenoise library. It builds a pure C executable. + +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. + +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, +and ship it to the maintainers. + +// end + +