Regression-test machinery is now documented.

diff --git a/README b/README
index 7605cce5120e0527d67406c6e3ce1800e3bc8a38..3426278d2dbed0704b0ab9ba90ef20834bcb2752 100644 (file)
--- a/README
+++ b/README
@@ -15,3 +15,5 @@ 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'.
+

diff --git a/TODO b/TODO
index 681e95987ca2f0055b91a4e2a19a1b852cfcc93e..777e9419c8a1d3c08f53eafe7a657ba9a9625b58 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,11 +1,8 @@
 = Open Adventure TODO =
 
-* Update the command parser to accept a PRNG seed value.
+* Find the extra 5 treasures.
 
-* Add command log replay.  Note that the replay log needs to begin
-  with the random-number seed.
-
-* Use that feature to make regression tests from walkthroughs.
+* Make more regression tests from walkthroughs.
 
 * Translate the FORTRANish mess to actual C.
 

diff --git a/tests/README b/tests/README
new file mode 100644 (file)
index 0000000..94fbe2d
--- /dev/null
+++ b/tests/README
@@ -0,0 +1,16 @@
+= Notes on the test machinery = 
+
+A .tst extension means it's a game log
+A .chk extension means it's expected output from a test
+
+In general, a file named foo.chk is the expected output from theb game log
+foo.log.  To add new tests, just drop log files in this directory.
+
+To see summary lines from all tests, 'make testlist'.  
+
+To run the tests, "make regress".
+
+To remake the check files, "make buildregress".
+
+// end
+