Update the README.

This commit is contained in:
John "Elwin" Edwards 2021-03-18 20:53:49 -04:00
parent 6aa43076d0
commit 6bb7e13c1f

View file

@ -3,10 +3,10 @@
This is the source for the Roguelike Gallery's versions of Rogue and other This is the source for the Roguelike Gallery's versions of Rogue and other
early roguelike games, including Super-Rogue, Advanced Rogue, and XRogue. early roguelike games, including Super-Rogue, Advanced Rogue, and XRogue.
The code was obtained from the Roguelike Restoration Project (Web site at The code was obtained from the Roguelike Restoration Project (Web site formerly
rogue.rogueforge.net). Modifications have been made for compatibility with the at rogue.rogueforge.net). Modifications have been made for compatibility with
dgamelaunch play system, and compliance with modern C compiler standards. Some the dgamelaunch play system, and compliance with modern C compiler standards.
bugs have also been fixed, and the build process slightly improved. The 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 essential flavor of a codebase half as old as stored-program computing
machinery remains unchanged. The gameplay and the user interface will be kept machinery remains unchanged. The gameplay and the user interface will be kept
true to the originals. true to the originals.
@ -16,8 +16,8 @@ Epyx for DOS, the Mac, and other graphical platforms of the 1980's. Nor does
it include Rogue Clone, a reimplementation sometimes found in BSD or Linux it include Rogue Clone, a reimplementation sometimes found in BSD or Linux
distributions. distributions.
UltraRogue has recently been added to the collection. It is still in an UltraRogue has recently been added to the collection. It is not quite in a
experimental state, with several known bugs. finished state. There are known bugs that could cause crashes.
--- Installation --- Installation
@ -38,8 +38,10 @@ There are other possible options; run './configure --help' for a full list.
To install on Windows: To install on Windows:
Visual Studio solution and project files are included. They are still being Warning: Windows installation was last tested on Windows 8.1.
tested but should work with Visual Studio 2015 on Windows 8.1.
Visual Studio solution and project files are included. They were created with
Visual Studio 2015.
You will need pdcurses before you can build. Create a folder called 'pdcurses' You will need pdcurses before you can build. Create a folder called 'pdcurses'
in this folder and copy into it curses.h, term.h, and pdcurses.lib from the in this folder and copy into it curses.h, term.h, and pdcurses.lib from the
@ -47,14 +49,12 @@ pdcurses distribution.
You can also build on Windows using MinGW. Make sure pdcurses is installed. You can also build on Windows using MinGW. Make sure pdcurses is installed.
You will have to go into the '/lib' folder and copy 'libpdcurses.a' to You will have to go into the '/lib' folder and copy 'libpdcurses.a' to
'libcurses.a', and 'libpdcurses.dll.a' to 'libcurses.dll.a'; this should get 'libcurses.a', and 'libpdcurses.dll.a' to 'libcurses.dll.a'.
fixed soon.
It is recommended to run 'configure' with the '--disable-logfile' option, and It is recommended to run 'configure' with the '--disable-logfile' option, and
'make' with the 'LDFLAGS=-static' option. 'make' with the 'LDFLAGS=-static' option.
UltraRogue is not yet integrated with Autoconf or the Visual Studio solution UltraRogue is not yet integrated with the Visual Studio solution file.
file.
See the individual games' subdirectories for further documentation. Some of See the individual games' subdirectories for further documentation. Some of
the manpages may be outdated, but the guides to playing should be accurate. the manpages may be outdated, but the guides to playing should be accurate.
@ -72,6 +72,7 @@ terms as the game to which they were made.
--- Bugs --- Bugs
The original authors claimed that the list of bugs was "probably infinite". If The original authors claimed that the list of bugs was "probably infinite".
you encounter one of these, please report it on the bug tracker at There was previously a bug tracker on Bitbucket, but Bitbucket seems to have
https://bitbucket.org/ElwinR/rl. been taken over by leprechauns, so bugs cannot be reported there. There will
be an announcement when a new bug tracker is set up.