annotate 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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
80
c8726c9fec82 Add a top-level README.txt.
John "Elwin" Edwards
parents:
diff changeset
1 This is the source for the Roguelike Gallery's versions of Rogue and other
c8726c9fec82 Add a top-level README.txt.
John "Elwin" Edwards
parents:
diff changeset
2 early roguelike games.
c8726c9fec82 Add a top-level README.txt.
John "Elwin" Edwards
parents:
diff changeset
3
c8726c9fec82 Add a top-level README.txt.
John "Elwin" Edwards
parents:
diff changeset
4 The code was obtained from the Roguelike Restoration Project
c8726c9fec82 Add a top-level README.txt.
John "Elwin" Edwards
parents:
diff changeset
5 (rogue.rogueforge.net). Modifications have been made mainly for compatibility
c8726c9fec82 Add a top-level README.txt.
John "Elwin" Edwards
parents:
diff changeset
6 with the dgamelaunch online play system. Some bugs have also been fixed, and
c8726c9fec82 Add a top-level README.txt.
John "Elwin" Edwards
parents:
diff changeset
7 the build process slightly improved. The essential flavor of a codebase half
c8726c9fec82 Add a top-level README.txt.
John "Elwin" Edwards
parents:
diff changeset
8 as old as stored-program computing machinery remains unchanged.
c8726c9fec82 Add a top-level README.txt.
John "Elwin" Edwards
parents:
diff changeset
9
106
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
10 To install on Unix:
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
11
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
12 If you checked out the source from Mercurial, run 'autoreconf' first.
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
13
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
14 Build by running './configure' and then 'make'. If you just want to play the
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
15 game from your own user account, 'configure' won't need any options. The
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
16 games will keep the high score lists in whatever directory you run them from.
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
17
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
18 For a multi-user installation, you will need to set the '--enable-setgid',
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
19 '--enable-savedir', '--enable-scorefile', and '--enable-logfile' options. Run
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
20 'make install' after building.
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
21
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
22 There are other possible options; run './configure --help' for a full list.
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
23
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
24 To install on Windows:
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
25
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
26 Use the included Visual Studio solution files. Warning: they have not been
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
27 tested recently.
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
28
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
29 See the individual games' subdirectories for further documentation. Some of
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
30 the manpages may be outdated, but the guides to playing should be accurate.
80
c8726c9fec82 Add a top-level README.txt.
John "Elwin" Edwards
parents:
diff changeset
31
c8726c9fec82 Add a top-level README.txt.
John "Elwin" Edwards
parents:
diff changeset
32 The games can be played via SSH or the Web at rlgallery.org.
106
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
33
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
34 Bugs:
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
35
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
36 The original authors claimed that the list of bugs was "probably infinite". If
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
37 you encounter one of these, please report it on the bug tracker at
c191a735f811 Update some of the documentation.
John "Elwin" Edwards
parents: 80
diff changeset
38 https://bitbucket.org/ElwinR/rl.