Minor documentation update.
[neverball] / INSTALL
1
2                             * Neverball *
3
4
5 * COMPILATION
6
7 Requirements:
8
9     SDL               http://www.libsdl.org/download-1.2.php
10     SDL_image         http://www.libsdl.org/projects/SDL_image/
11     SDL_mixer         http://www.libsdl.org/projects/SDL_mixer/
12     SDL_ttf           http://www.libsdl.org/projects/SDL_ttf/
13
14 Under Unix, Linux, and OSX, simply run
15
16     make
17
18 Under Windows, build using the provided Visual Studio solution.
19
20 By default, an uninstalled build may be executed in place.
21
22
23 * INSTALLATION
24
25 The game  searches for game assets  in the following  three places, in
26 this order.  If the game is  to be installed globally, at least one of
27 them must be set.
28
29 1) The directory specified on the command line.
30
31 2) The directory given by the NEVERBALL_DATA environment variable.
32
33 3) The directory given by the CONFIG_DATA variable defined in config.h
34
35 A normal Linux installation would  probably copy the data directory to
36 "/usr/local/games/neverball/" and  change the CONFIG_DATA  variable to
37 match.
38
39 A  normal  Windows installation  would  simply  copy  the entire  game
40 directory  to "C:\Program Files\Neverball"  and leave  the CONFIG_DATA
41 variable to its default value "./data".
42
43
44 * DISTRIBUTION
45
46 The dist directory contains some miscellaneous files:
47
48   * manual pages
49   * .desktop files
50   * icons
51
52 Contact: <robert.kooima@gmail.com>