changeset 106:c191a735f811

Update some of the documentation.
author John "Elwin" Edwards
date Wed, 04 Sep 2013 09:01:44 -0700
parents f0073eb75a6a
children f2951c4e28d9
files README.txt rogue3/INSTALL.txt rogue3/rogue.6.in rogue4/INSTALL.txt
diffstat 4 files changed, 35 insertions(+), 9 deletions(-) [+]
line wrap: on
line diff
--- a/README.txt	Tue Sep 03 15:39:04 2013 -0700
+++ b/README.txt	Wed Sep 04 09:01:44 2013 -0700
@@ -7,6 +7,32 @@
 the build process slightly improved.  The essential flavor of a codebase half
 as old as stored-program computing machinery remains unchanged.
 
-See the individual games' subdirectories for their documentation.
+To install on Unix:
+
+If you checked out the source from Mercurial, run 'autoreconf' first.
+
+Build by running './configure' and then 'make'.  If you just want to play the 
+game from your own user account, 'configure' won't need any options.  The 
+games will keep the high score lists in whatever directory you run them from.
+
+For a multi-user installation, you will need to set the '--enable-setgid',
+'--enable-savedir', '--enable-scorefile', and '--enable-logfile' options.  Run
+'make install' after building.
+
+There are other possible options; run './configure --help' for a full list.
+
+To install on Windows:
+
+Use the included Visual Studio solution files.  Warning: they have not been 
+tested recently.
+
+See the individual games' subdirectories for further documentation.  Some of 
+the manpages may be outdated, but the guides to playing should be accurate.
 
 The games can be played via SSH or the Web at rlgallery.org.
+
+Bugs:
+
+The original authors claimed that the list of bugs was "probably infinite".  If 
+you encounter one of these, please report it on the bug tracker at 
+https://bitbucket.org/ElwinR/rl.
--- a/rogue3/INSTALL.txt	Tue Sep 03 15:39:04 2013 -0700
+++ b/rogue3/INSTALL.txt	Wed Sep 04 09:01:44 2013 -0700
@@ -24,10 +24,9 @@
 the game yourself, this will work.
 
 If you want multi-user play, use the '--enable-setgid' and '--enable-savedir'
-options to 'configure'.  After compiling, install the rogue3 binary with setgid
-games.  You will need to make sure that the save directory exists and that
-savefiles, the scorefile, and the logfile can be created and written by the
-games group (assuming you want those features.)
+options to 'configure'.  You will also likely want to use '--enable-scorefile' 
+and '--enable-logfile' to set the locations of those files.  After compiling, 
+run 'make install'.
 
 There are other possible features, including wizard (debugging) mode.  To see
 the full list, run './configure --help'.
@@ -37,4 +36,4 @@
 (Michael Toy's "Guide to the Dungeons of Doom").
 
 Contact
-rlgallery.org admin: John "Elwin" Edwards <elwin@sdf.lonestar.org>
+rlgallery.org admin: John "Elwin" Edwards <elwin@sdf.org>
--- a/rogue3/rogue.6.in	Tue Sep 03 15:39:04 2013 -0700
+++ b/rogue3/rogue.6.in	Wed Sep 04 09:01:44 2013 -0700
@@ -67,7 +67,7 @@
 .br
 ~/rogue3.save                           Default save file
 .br
-/usr/local/games/roguelike/rogue3save   System savefiles
+@SAVEDIR@   System savefiles
 .DT
 .SH SEE ALSO
 Michael C. Toy,
--- a/rogue4/INSTALL.txt	Tue Sep 03 15:39:04 2013 -0700
+++ b/rogue4/INSTALL.txt	Wed Sep 04 09:01:44 2013 -0700
@@ -21,7 +21,8 @@
 If you want multi-user play, run configure with the proper options ("configure
 --help" will explain what they do.)  The important ones are savedir (where
 saved games are stored), scorefile (the high score list), and logfile (the log
-of all games played).
+of all games played).  You should probably also use '--enable-setgid=games' and 
+'--disable-lockfile'.
 
 On Windows, I haven't tested the Visual Studio project files; the game should
 build, but the scorefile might not work. 
@@ -33,4 +34,4 @@
 versions in more common formats soon.
 
 Contact
-rlgallery.org admin: John "Elwin" Edwards <elwin@sdf.lonestar.org>
+rlgallery.org admin: John "Elwin" Edwards <elwin@sdf.org>