Removed advent.info and added to .gitignore

[open-adventure.git] / README.adoc

diff --git a/README.adoc b/README.adoc
index b513dc453a8f92d5da21cf78e76fc60152a4a07e..6fd1b4eb4ba3ec43b076116913df1052706950a9 100644 (file)
--- a/README.adoc
+++ b/README.adoc
@@ -6,7 +6,8 @@ development written by the original authors.  The authors have given
 permission and encouragement for this release.
 
 The file history.adoc contains a more detailed history of this game
 permission and encouragement for this release.
 
 The file history.adoc contains a more detailed history of this game

-and its ancestors.
+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
 
 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.
 
 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
+
+