JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
Added .gitignore, stopped tracking data/font.png.
[vor.git] / INSTALL
1 REQUIREMENTS
2
3         vor requires the following libraries to build/run:
4                 sdl           http://www.libsdl.org/download-1.2.php
5                 sdl_mixer     http://www.libsdl.org/projects/SDL_mixer/
6                 sdl_image     http://www.libsdl.org/projects/SDL_image/
7         And the following to create the graphics:
8                 povray        http://www.povray.org/
9                 netpbm        http://netpbm.sourceforge.net/
10
11 BUILDING
12         
13         "cd" to the vor source directory and type "make" at the command prompt.
14
15         For the brave: see also BUILDING ON WINDOWS below
16
17 RUNNING
18
19         "./vor"
20
21         After building you should have an executable called "vor" in the
22         current (source) directory. You can run this here, "./vor"
23
24 INSTALLING
25
26         Just type "make install" at the command prompt.
27
28         By default it puts the executable in /usr/games/bin and the data in
29         /usr/share/vor. If you'd like to change either, edit the Makefile
30         before building. If you change these settings in the Makefile after
31         building, you'll have to "make clean" and build again before
32         installing.
33
34
35
36 BUILDING ON WINDOWS
37
38         1) Grab a copy of the vor source code with the images already rendered. If
39         you want to compile from the latest sources in the repository, you'll have
40         to check out onto a unix machine, and "make data" to render the ships and
41         rocks. The source tarballs usually have these rendered already.
42
43         2) download sdl source from libsdl.org. follow these instructions to
44         install msys, mingw, and sdl:
45
46         http://www.libsdl.org/extras/win32/mingw32/README.txt
47
48         stay in the shell for step 3:
49
50         3) download, unpack and install sdl-mixer and sdl-image from source (should
51         (I hope) work the same way as installing sdl in step 2 above.)
52
53         http://www.libsdl.org/projects/SDL_mixer/index.html
54         http://www.libsdl.org/projects/SDL_image/index.html
55
56         4) run this command in the vor source directory: mingw-make -f Makefile.win