diff README.txt @ 106:c191a735f811

Update some of the documentation.
author John "Elwin" Edwards
date Wed, 04 Sep 2013 09:01:44 -0700
parents c8726c9fec82
children 65f3da34578a
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.