summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorNick White <git@njw.me.uk>2010-07-29 19:09:26 +0100
committerNick White <git@njw.me.uk>2010-07-29 19:09:26 +0100
commitca61acd4506afb0125ae64b33f5f90ee198c0f6e (patch)
tree5025ec5d4bbf8c2494f393e0699ac236fb8e58d6 /README
parent3a4a0d3f39c25adb6bc8ead135ed39634b2bcfbf (diff)
Simplify things alot, and add zoom and fullscreen
Added some documentation Improved build system Consolidated code into spout.c Added fullscreen option Added zoom option Removed unneeded functions
Diffstat (limited to 'README')
-rw-r--r--README29
1 files changed, 29 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..f46bc73
--- /dev/null
+++ b/README
@@ -0,0 +1,29 @@
+Spout
+=====
+
+Spout is a simple caveflying game. The object is to get as high as possible, avoiding or destroying obstacles.
+
+Requirements
+------------
+
+* libSDL
+
+Install
+-------
+
+Edit config.mk to your liking, then run 'make install'
+
+Controls
+--------
+
+Left: Rotate left
+Right: Rotate right
+Space: Accelerate
+Exit: Shift-Esc
+
+History
+-------
+
+Spout was originally made for a handheld by kuni, and soon afterwards was ported to Windows using cygwin and sdl, licensed under the MIT license; see http://www.din.or.jp/~ku_/junk/junk.htm#spout
+In 2004 a 'unix version' was released, which mostly just slapped autotools into the windows version and infringed the license: http://code.mizzenblog.com/category/spout/
+This is a new unix version, based on the original Windows code by kuni, which aims to add useful features and simplify the code.