rnd-19990205-1
[rocksndiamonds.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 298ff6d..697475a 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,68 +1,85 @@
 
-WHAT TO DO TO INSTALL "ROCKS_N_DIAMONDS-0.9" ON YOUR SYSTEM
-===========================================================
-
-If you have a Linux system (Intel based, a.out, kernel 1.2.x), you
-can use the precompiled binary.
-
-If you have another Unix system, or an ELF system or just want to
-compile the program by yourself, do the following:
-
-Edit the file "Makefile" and set the following options:
-
-XPM_INCLUDE_FILE       -       change this to the location where you
-                               have your XPM-Library include file.
-
-                               You must have the XPM-Library "libXpm"
-                               installed on your system to run this game.
-                               If you don't have it, look at your local
-                               FTP site with X11 archive to get it! :)
-
-GAME_DIR               -       You can leave these values untouched
-                               if you use the default location for
-                               the game directory.
-                               If you want to move it to other places in
-                               your directory tree, just change them
-                               accordingly. (You can use symlinks instead,
-                               of course.)
-                               You might want to set GAME_DIR to the full
-                               path of the game in your file system, so
-                               you don't have to go to the game directory
-                               when you want to play it.
-
-SOUNDS                 -       If you never want to hear any sounds,
-                               set this to "-DNO_SOUNDS", but be warned:
-                               It's much less fun playing without sound! :)
-                               (The program detects by itself if it can
-                               play sounds or not, anyway.)
-
-SCORE_ENTRIES          -       Set this to "-DONE_PER_NAME" if you want
-                               to allow only one entry per player in the
-                               score file for each level. This is useful
-                               if there are many players to prevent one
-                               single player to "flood" the Hall Of Fame
-                               of every level completely with his name...
-                               On single user systems, "-DMANY_PER_NAME"
-                               might be useful to have your name more
-                               than once in the list.
-
-SYSTEM                 -       If you have problems with the default
-                               settings, it might be useful to uncomment
-                               one of the defines for "SYSTEM" in the
-                               Makefile, which defines values like
-                               "-DSYSV" and something like that.
-
-CC, INCL, LIBS         -       Set these ones to the appropriate values
-                               you usually use on your system to compile.
-
-
-Now you can 'make clean' and 'make' and the game binary should be
-compiled right out of the box. I have tested it with "-Wall" on my
-system, so I hope that it compiles fine on other systems, too.
-
-The program should compile and run on Linux (of course),
-HP-UX, AIX, Net-BSD, SUN and IRIX.
-
-Have fun!
-
-Holger Schemel, 22. Oktober 1995
+Installation instructions for Rocks'n'Diamonds 1.2.0
+====================================================
+
+Compilation
+-----------
+
+If your system supports Linux/i386/ELF/libc5 executables (Linux package)
+or if you run DOS/Windows (DOS package), you can directly use the included
+precompiled binary.
+
+If you use a different system, just recompile the game:
+
+If you use Linux with gcc or DOS/Windows with djgpp, just try 'make'
+which should work without problems.
+
+If you use SUN/Solaris with gcc and GNU make, try 'make solaris'.
+
+If the above doesn't work, edit the Makefile in the top level directory.
+If it doesn't work either, edit the Makefile in the 'src' subdirectory.
+
+If you had to modify any Makefile to compile it, please drop me a note
+about it to 'aeglos@valinor.owl.de'. Thanks!
+
+
+Customization
+-------------
+
+The following configuration options in the top level Makefile help
+you to customize the game to your system and your environment:
+
+CC             Choose your favorite ANSI C compiler.
+               Default is 'gcc'.
+
+PLATFORM       Choose your platform, if auto detection fails.
+               Auto detection should work for Linux and DOS
+               (just type 'make'), on SUN/Solaris systems 'make solaris'
+               should work. Other systems may need additional editing
+               of 'src/Makefile' to set some additional compiler options.
+
+X11_PATH       Specify the path to your X11 installation. Include files
+               and libraries are searched for at $(X11_PATH)/include and
+               $(X11_PATH)/lib, if you set this variables. If you don't
+               set this variable, your compiler must be able to find X11
+               by itself, which works fine for Linux, for example.
+
+GAME_DIR       Specify the directory where the program looks for all the
+               graphics, sounds, levels and high scores. If you leave this
+               commented out, the current directory ('.') is used, which
+               lets you use the game without installing it somewhere in
+               your system (although you have to 'cd' to the game directory
+               each time you want to play it).
+
+JOYSTICK       Uncomment this line if your system does not support game
+               port hardware like joysticks (and has therefore no joystick
+               include file). Currently the game should work with joysticks
+               on Linux and FreeBSD.
+
+SOUNDS         Uncomment this line if your system does not support audio
+               hardware. Currently the game should work with sound support
+               on Linux, FreeBSD, SUN/Solaris, HP-UX and most Unix system
+               that support '/dev/dsp' or '/dev/audio' devices.
+
+SCORE_ENTRIES  Choose if you want to allow many entries in the high score
+               table for one player or exactly one entry. Systems with a
+               lot of users maybe want to limit high score entries to only
+               one entry for each player (and therefore set 'SCORE_ENTRIES'
+               to 'ONE_PER_NAME') where systems used by only one person
+               maybe want to use the default of 'MANY_PER_NAME' which is
+               automatically choosen if you leave everything commented out.
+
+Modifications of the Makefile in the directory 'src' are normally not needed.
+If the game fails to compile out of the box, you may have to modify some
+of the system variables there to get it to compile.
+
+SYSTEM         May need to be set to some system dependend values.
+
+INCL, LIBS     Maybe some more directories for include files and libraries
+               have to be added to this variables depending on your system.
+
+
+If you have any comments, additions or modifications to the Makefile(s),
+please send me mail: 'aeglos@valinor.owl.de'. Thanks!
+
+05-DEC-1998, Holger Schemel