1Installation Instructions
2=========================
3
4Requirements
5------------
6
7vor requires the following libraries to build/run:
8
9*	sdl           http://www.libsdl.org/download-1.2.php
10*	sdl_mixer     http://www.libsdl.org/projects/SDL_mixer/
11*	sdl_image     http://www.libsdl.org/projects/SDL_image/
12
13If you are building from git, (or editing the graphics) you will also
14need:
15
16	autoconf      version 2.63 or greater
17
18You'll also need the graphics (`data` subdir) from the tarbal, or the following
19packages to render the graphics:
20
21	povray        http://www.povray.org/
22	povray-includes  (if your distribution ships this in a separate package)
23	netpbm        http://netpbm.sourceforge.net/
24
25
26Building From A Release Tarball
27-------------------------------
28
29(See Building From Git below if you don't have a release tarball)
30
31change to the source directory and run this:
32
33./configure && make
34
35Unless there are errors, you should be able to run the game from the
36source directory like this:
37
38./vor
39
40
41Building From Git
42-----------------
43
441.	Make sure you have the extra dependencies first. If you want to avoid
45	installing povray and/or netpbm, you can simply copy the data/ directory
46	from a recent release.
47
482.	Run ``autoreconf``
49
503.	Continue as normal with the Building From A Release Tarball section above.
51
52
53Building For Windows
54--------------------
55
56These instructions should work on most any modern GNU/Linux system, and maybe
57other Unix-like systems.
58
591.	Download MXE (and install its dependencies) by following just step 1 of
60	this tutorial:
61
62	http://mxe.cc/#tutorial
63
642.	`cd` into the `mxe` directory
65
663.	Run this: (takes some patience)
67
68		make gcc
69
704.	Run this:
71
72		make sdl-image sdl-mixer
73
745.	Set up your environment for cross-compiling:
75
76		export PATH="/PATH/TO/YOUR/MXE/DIR/usr/bin:$PATH"
77
786.	`cd` to vor source directory.
79
807.	Build VoR with this command:
81
82		./configure --host=i686-pc-mingw32 && make
83
84
85Running
86-------
87
88	You can run VoR from the source directory without installing it:
89
90		./vor
91
92	add `-h` to see commandline arguments.
93
94	See `README` file for keys, etc.
95
96
97Installing
98----------
99
100	You can run `make install` to install vor. If you're installing
101	system-wide (for example, to the default install location of `/usr/local`)
102	you'll need to run this as root.
103
104	You can specify an alternative install location with the `--prefix=`
105	argument to `./configure`. See the output of: `./configure --help` for more
106	information.
107