Punctuation fix.

[super-star-trek.git] / doc / HACKING

diff --git a/doc/HACKING b/doc/HACKING
index 46c35425f41eb06a3da5be3898fabcfc5c07e8b3..133f72f6e84c9bbe93f7540252a2d9466978d175 100644 (file)
--- a/doc/HACKING
+++ b/doc/HACKING
@@ -56,7 +56,7 @@ however mine had some feature it didn't have. So I merged its
 features that I liked. I also took a peek at the DECUS version (a
 port, less sources, to the PDP-10), and some other variations.
 
-1, Compared to the original UT version, I've changed the "help"
+1. Compared to the original UT version, I've changed the "help"
 command to "call" and the "terminate" command to "quit" to better
 match user expectations. The DECUS version apparently made those
 changes as well as changing "freeze" to "save". However I like
@@ -210,6 +210,11 @@ and added more:
 the LRSCAN command is no longer needed.  (Controlled by OPTION_AUTOSCAN
 and turned off if game type is "plain" or "almy".)
 
+10. I imported Tom Almy's SCORE, CAPTURE, and CLOAK command from his
+2013 version.
+
+11. I added color.
+
 TESTING:
 
 This code has been designed to be tested.  A simple shellscript
@@ -222,7 +227,21 @@ you haven't broken anything.
 
 When you fix a bug, add the log of the game that triggered it (and
 a checkfile) to the regression tests. This is how we improve the code
-coverage of the suite.
+coverage of the suite. 
+
+Two things to do to the log before dropping it in the test directory:
+
+(a) Strip out all lines beginning with "#curses:" - these are for debugging
+the curses interface and are not needed or regression testing; removing
+them makes it easier to see the game commands.
+
+(b) Add a header comment line explaining what the log is a test for.
+It should begin with "# Tests". This is what gets echoed before each
+regression test is run.
+
+Then drop it into the test directory and "make buildregress" to create
+the check file. (Don't forget to commit and push the log and checkfile
+to the repository.)
 
 NOTES ON THE PYTHON TRANSLATION: