updated 'INSTALL' file
authorHolger Schemel <info@artsoft.org>
Sat, 2 Jan 2016 19:37:28 +0000 (20:37 +0100)
committerHolger Schemel <info@artsoft.org>
Sat, 2 Jan 2016 19:37:28 +0000 (20:37 +0100)
INSTALL

diff --git a/INSTALL b/INSTALL
index d014b7a..bdca6cb 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,88 +1,36 @@
+===============================================================================
+Compiling and installing Rocks'n'Diamonds
+===============================================================================
 
-Installation instructions for Rocks'n'Diamonds
-==============================================
+To compile the game, you either need the new SDL2 library (recommended) or the
+old SDL 1.2 library. In addition, you also need the libraries SDL_image,
+SDL_mixer (including the SMPEG library if you want MP3 support) and SDL_net.
 
-Compilation
------------
+Please install these libraries before building Rocks'n'Diamonds.
 
-If your system supports Linux/i386/ELF/glibc 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:
+-------------------------------------------------------------------------------
+Linux and other Unix systems (including Mac OS X):
+-------------------------------------------------------------------------------
 
-If you use Linux with gcc or DOS or Windows 3.x with djgpp, just try 'make'
-which should work without problems.
+Just run "make" to build the game using either SDL2 or SDL (whatever being
+available).
 
-If you use SUN/Solaris with gcc and GNU make, try 'make solaris'.
+Run "make sdl" or "make sdl2" to explicitly use either SDL 1.2 or SDL2.
 
-To build the game with SDL support (needed for fullscreen and MOD support),
-type "make sdl". You need at least SDL version 1.1.x and the additional
-SDL libraries SDL_image and SDL_mixer. To get a recent version of the SDL
-library, see http://www.libsdl.org.
 
-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.
+-------------------------------------------------------------------------------
+Windows with gcc (native or cross-compiling)
+-------------------------------------------------------------------------------
 
-If you had to modify any Makefile to compile it, please drop me a note
-about it to 'info@artsoft.org'. Thanks!
+To build the game natively, just proceed as described above for Unix systems.
 
+To cross-compile the game for Windows, run "cross-win32". You probably have to
+adjust the path to the Windows cross-compiler defined in "CROSS_PATH_WIN32" in
+the top-level Makefile.
 
-Customization
--------------
 
-The following configuration options in the top level Makefile help
-you to customize the game to your system and your environment:
+That's all!
 
-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: 'info@artsoft.org'. Thanks!
+If you have any comments, corrections or suggestions regarding the Makefiles,
+please let me know at "info@artsoft.org". Thanks!