X-Git-Url: https://jasonwoof.com/gitweb/?p=vor.git;a=blobdiff_plain;f=INSTALL;h=cffa8a0e19611db2c9df2407c7a4781e82056eac;hp=ec199222c4a2929e01eccaf465298cd3f841bbe7;hb=HEAD;hpb=88a9e026caed5568363cefb7d49308b875dc5e4a

diff --git a/INSTALL b/INSTALL
index ec19922..cffa8a0 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,56 +1,106 @@
-REQUIREMENTS
+Installation Instructions
+=========================
 
-	vor requires the following libraries to build/run:
-		sdl           http://www.libsdl.org/download-1.2.php
-		sdl_mixer     http://www.libsdl.org/projects/SDL_mixer/
-		sdl_image     http://www.libsdl.org/projects/SDL_image/
-	And the following to create the graphics:
-		povray        http://www.povray.org/
-		netpbm        http://netpbm.sourceforge.net/
+Requirements
+------------
 
-BUILDING
+vor requires the following libraries to build/run:
+
+*	sdl           http://www.libsdl.org/download-1.2.php
+*	sdl_mixer     http://www.libsdl.org/projects/SDL_mixer/
+*	sdl_image     http://www.libsdl.org/projects/SDL_image/
+
+If you are building from git, (or editing the graphics) you will also
+need:
+
+	autoconf      version 2.63 or greater
+
+You'll also need the graphics (`data` subdir) from the tarbal, or the following
+packages to render the graphics:
+
+	povray        http://www.povray.org/
+	povray-includes  (if your distribution ships this in a separate package)
+	netpbm        http://netpbm.sourceforge.net/
+
+
+Building From A Release Tarball
+-------------------------------
+
+(See Building From Git below if you don't have a release tarball)
+
+change to the source directory and run this:
+
+./configure && make
+
+Unless there are errors, you should be able to run the game from the
+source directory like this:
+
+./vor
+
+
+Building From Git
+-----------------
+
+1.	Make sure you have the extra dependencies first. If you want to avoid
+	installing povray and/or netpbm, you can simply copy the data/ directory
+	from a recent release.
+
+2.	Run ``autoreconf``
+
+3.	Continue as normal with the Building From A Release Tarball section above.
+
+
+Building For Windows
+--------------------
+
+These instructions should work on most any modern GNU/Linux system, and maybe
+other Unix-like systems.
+
+1.	Download MXE (and install its dependencies) by following just step 1 of
+	this tutorial:
+
+	http://mxe.cc/#tutorial
 	
-	"cd" to the vor source directory and type "make" at the command prompt.
+2.	`cd` into the `mxe` directory
+
+3.	Run this: (takes some patience)
 
-	For the brave: see also BUILDING ON WINDOWS below
+		make gcc
 
-RUNNING
+4.	Run this:
 
-	"./vor"
+		make sdl-image sdl-mixer
+	
+5.	Set up your environment for cross-compiling:
 
-	After building you should have an executable called "vor" in the
-	current (source) directory. You can run this here, "./vor"
+		export PATH="/PATH/TO/YOUR/MXE/DIR/usr/bin:$PATH"
 
-INSTALLING
+6.	`cd` to vor source directory.
 
-	Just type "make install" at the command prompt.
+7.	Build VoR with this command:
 
-	By default it puts the executable in /usr/games/bin and the data in
-	/usr/share/vor. If you'd like to change either, edit the Makefile
-	before building. If you change these settings in the Makefile after
-	building, you'll have to "make clean" and build again before
-	installing.
+		./configure --host=i686-pc-mingw32 && make
 
 
+Running
+-------
 
-BUILDING ON WINDOWS
+	You can run VoR from the source directory without installing it:
 
-	1) Grab a copy of the vor source code with the images already rendered. If
-	you want to compile from the latest sources in the repository, you'll have
-	to check out onto a unix machine, and "make data" to render the ships and
-	rocks. The source tarballs usually have these rendered already.
+		./vor
 
-	2) download sdl source from libsdl.org. follow these instructions to
-	install msys, mingw, and sdl:
+	add `-h` to see commandline arguments.
 
-	http://www.libsdl.org/extras/win32/mingw32/README.txt
+	See `README` file for keys, etc.
 
-	stay in the shell for step 3:
 
-	3) download, unpack and install sdl-mixer and sdl-image from source (should
-	(I hope) work the same way as installing sdl in step 2 above.)
+Installing
+----------
 
-	http://www.libsdl.org/projects/SDL_mixer/index.html
-	http://www.libsdl.org/projects/SDL_image/index.html
+	You can run `make install` to install vor. If you're installing
+	system-wide (for example, to the default install location of `/usr/local`)
+	you'll need to run this as root.
 
-	4) run this command in the vor source directory: mingw-make -f Makefile.win
+	You can specify an alternative install location with the `--prefix=`
+	argument to `./configure`. See the output of: `./configure --help` for more
+	information.