From: Jason Woofenden <jason@jasonwoof.com>
Date: Mon, 18 Apr 2005 17:20:35 +0000 (+0000)
Subject: added README and INSTALL (with dependancies :))
X-Git-Tag: 0.3~21
X-Git-Url: https://jasonwoof.com/gitweb/?p=vor.git;a=commitdiff_plain;h=e3ee5ceeccdd8f3b82c7ec2df50e3a9f2c77914d

added README and INSTALL (with dependancies :))
---

diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..aa22cc8
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,31 @@
+REQUIREMENTS
+
+	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/
+
+BUILDING
+	
+	"cd" to the vor source directory and type "make" at the command prompt.
+
+RUNNING
+
+	"./vor"
+
+	After building you should have an executable called "vor" in the
+	current (source) directory. You can run this here, "./vor"
+
+INSTALLING
+
+	Just type "make install" at the command prompt.
+
+	By default it puts 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.
+
diff --git a/README b/README
new file mode 100644
index 0000000..cc7bf7c
--- /dev/null
+++ b/README
@@ -0,0 +1,51 @@
+Variations on Rockdodger
+
+vor is a quick action game where you drive a space ship and try to avoid
+crashing into rocks. Current information about vor can be found on the
+homepage: http://herkamire.com/jason/vor
+
+See INSTALL for instructions on building, running and installing.
+
+Jason Woofenden and Josh Grams like rockdodger
+(http://spacerocks.sourceforge.net/) very much: both playing it and hacking on
+it. VoR is the result. It is currently based on the rockdodger 0.4.2 codebase,
+with quite a few modifications, both user-visible changes and internal
+technical improvements.
+
+Available for download from http://qualdan.com/vor/, or you can check out the
+latest SVN copy from http://josh.qualdan.com:3/svn/vor/trunk/ (Warning: Not
+Always On).
+
+Note: This is a fairly hard game, intended to be a quickie game for when you
+want to kill a few spare minutes. For reference, my best time [Josh Grams] is
+about 3 minutes. I'm not generally very good at video games, but I have been
+playing this one for quite a while now. However, you can make it substantially
+easier by slowing the game down. New in version 0.2, we have a constant
+GAMESPEED in config.h. New players may like to try it at 3/4 or even 2/3 speed.
+It should probably be a command-line option, but I'm too lazy to fix that right
+now.
+
+Changes from Rock Dodgers
+
+User-Visible Changes:
+
+  * Moves like a real spacecraft; no more friction!
+  * No more silly shields or lasers; just pure rockdodgin' fun!
+  * Up/down scrolling; gives you more escape options.
+  * Proper time display for score, not just raw milliseconds (bleh).
+  * Ship explodes, blowing rocks away, rather than automagically vanishing
+    them.
+  * New graphics, generated by POV-Ray. Yeah, okay, the ship is really cheezy.
+    At least the rocks are cool.
+  * Real collision detection; no more "ship is 1 pixel bigger all around
+    than it looks."
+
+Internal Technical Changes:
+
+  * Upgraded to SFont 2.03, which has way less cruft, but no text input
+    routine.
+  * Started factoring a lot of stuff out of main into their own .c files.
+  * Removed a bunch of unused code.
+  * Function definitions: name at beginning of line (line following the return
+    type) for easy grepping as per GNU coding standards.
+  * Real collision detection (bbox/bitmask).