info: New Common-Fever, Hvy-Fever

[empserver] / info / README

diff --git a/info/README b/info/README
index b2a06f337b3dc7a8eb24b26f05ad53db302942ce..838aad4163a20455ccce4680345485bea3efc4ee 100644 (file)
--- a/info/README
+++ b/info/README
@@ -4,9 +4,12 @@ Make remakes info pages, table of contents and index automatically.
 This requires Perl 5 and troff.  To remake just formatted info pages,
 run make info.
 
-To remake HTML info, run make html.  This is not done by default.  The
+To make HTML info, run make html.  This is not done by default.  The
 recommended start page is TOP.html, but you may also like all.html.
 
+To make a single PostScript file for printing, run make info.ps.  This
+is not done by default.  The result is currently quite ugly.
+
 
         --- How to add a new info page ---
 
@@ -43,6 +46,8 @@ The first line must be a title header:
 The second line must be a name header:
 .NA arg1 arg2
   - arg1 must be the name
+  - if the info page is for an Empire command, then arg2 must be the
+    exact command name
   - arg2 is a one-line description of the info page which will be put
     on the subject pages that your info page belongs to.  It should be
     in double quotes
@@ -85,7 +90,8 @@ Fancy troff magic is prone to break HTML output.
 
 4. Format your info page, update table of contents and index
   Run make info html.  If it fails, peruse the error messages and fix
-  your info page.
+  your info page.  Run tests/info-test for additional consistency
+  checking.
 
 
 ==APPENDIX A  -  What exactly the Perl scripts do==
@@ -99,16 +105,3 @@ The output of these scripts is a bunch of .t files.  The file TOP.t is
 the top-level table of contents and lists all of the subjects.  Then
 for each SUBJECT, a SUBJECT.t file is created, listing all of the info
 pages that belong to it.
-
-
-==APPENDIX B  -  The checklist.pl script==
-
-FIXME This does not work at the moment
-
-This little perl script compares the "list" of legal Empire commands
-in your server with the Empire commands documented in info.  To run
-it, login to your game and type:
-
-  [##:##]% list > list.out
-
-Then, move the list.out file to this directory and run checklist.pl.