From 05b8759305dd484e1fce406be2357ebebe110074 Mon Sep 17 00:00:00 2001 From: "John \"Elwin\" Edwards" Date: Wed, 4 Sep 2013 09:01:44 -0700 Subject: [PATCH] Update some of the documentation. --- README.txt | 28 +++++++++++++++++++++++++++- rogue3/INSTALL.txt | 9 ++++----- rogue3/rogue.6.in | 2 +- rogue4/INSTALL.txt | 5 +++-- 4 files changed, 35 insertions(+), 9 deletions(-) diff --git a/README.txt b/README.txt index b37dc54..ddc4de8 100644 --- a/README.txt +++ b/README.txt @@ -7,6 +7,32 @@ with the dgamelaunch online play system. Some bugs have also been fixed, and 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. diff --git a/rogue3/INSTALL.txt b/rogue3/INSTALL.txt index 5b2d082..b60a848 100644 --- a/rogue3/INSTALL.txt +++ b/rogue3/INSTALL.txt @@ -24,10 +24,9 @@ score list in whatever directory you run it from. If you just want to play 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 @@ For more details, see readme36.html (contains the man page) and rogue36.html (Michael Toy's "Guide to the Dungeons of Doom"). Contact -rlgallery.org admin: John "Elwin" Edwards +rlgallery.org admin: John "Elwin" Edwards diff --git a/rogue3/rogue.6.in b/rogue3/rogue.6.in index 3d10e48..931c774 100644 --- a/rogue3/rogue.6.in +++ b/rogue3/rogue.6.in @@ -67,7 +67,7 @@ option prints the top-ten scores list and exits. .br ~/rogue3.save Default save file .br -/usr/local/games/roguelike/rogue3save System savefiles +@SAVEDIR@ System savefiles .DT .SH SEE ALSO Michael C. Toy, diff --git a/rogue4/INSTALL.txt b/rogue4/INSTALL.txt index b8d9cf9..ab5d8c6 100644 --- a/rogue4/INSTALL.txt +++ b/rogue4/INSTALL.txt @@ -21,7 +21,8 @@ the options for "configure" and leave off the "make install". 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 @@ you should be able to discover something with a text editor. I plan to add versions in more common formats soon. Contact -rlgallery.org admin: John "Elwin" Edwards +rlgallery.org admin: John "Elwin" Edwards