Add the beginnings of a regression-test suite.

[super-star-trek.git] / test / README

diff --git a/test/README b/test/README
new file mode 100644 (file)
index 0000000..57c32e7
--- /dev/null
+++ b/test/README
@@ -0,0 +1,13 @@
+This directory contains regression test pairs for SST.
+
+A regression test log is just a command capture from a game with a QUIT
+appended to tell it to exit.  The corresponding check file is just the
+output stimulated by the log.  All files with extension ".log" in this
+directory will be treated as test logs, with each corresponding checkfile
+having extension ".chk".
+
+"make regress" checks that the output of the logfiles is stable. It
+will show context diffs when the actual output is different from the
+checkfile.
+
+"make buildregress" rebuilds all check files from their logs.