changeset 13:65d9de520328

Initial stab at README.txt file.
author Simon Cross <hodgestar+bzr@gmail.com>
date Sun, 22 Aug 2010 16:20:39 +0200
parents a491233b39ae
children a02dc1e26c60
files README.txt
diffstat 1 files changed, 51 insertions(+), 17 deletions(-) [+]
line wrap: on
line diff
--- a/README.txt	Sun Aug 22 16:14:12 2010 +0200
+++ b/README.txt	Sun Aug 22 16:20:39 2010 +0200
@@ -1,40 +1,74 @@
 Your Game Title
 ===============
 
-Entry in PyWeek #4  <http://www.pyweek.org/4/>
-Team: YOUR TEAM NAME (leave the "Team: bit")
-Members: YOUR TEAM MEMBERS (leave the "Members: bit")
+Entry in PyWeek #11  <http://www.pyweek.org/11/>
+Team: Boomslang
+Members:
 
+    Adrianna Pinska
+    Jeremy Thurgood
+    Neil Muller
+    Simon Cross
+    Stefano Rivera
 
-DEPENDENCIES:
+A second PyWeek entry by the hackers of the Cape Town Python Users Group
+(CTPUG). The theme for PyWeek 11 was "Caught".
 
-You might need to install some of these before running the game:
+RUNNING THE GAME
+================
 
-  Python:     http://www.python.org/
-  PyGame:     http://www.pygame.org/
-  PyOpenGL:   http://pyopengl.sf.net/
+It is likely that you have obtain the game in one of four possible ways:
+
+Windows:
 
+If you have the Windows .zip file, unzip it, find foxassault.exe and
+doube-click it to launch the game.
+
+Unix:
 
+If you have the Unix .tgz file, make sure you have Python and pygame
+installed. The extract the tar file and run "python run_game.py" from
+inside the extracted folder.
 
-RUNNING THE GAME:
+Mac OS X:
 
-On Windows or Mac OS X, locate the "run_game.pyw" file and double-click it.
+If you have the Mac OS X .dmg file, double-click to open it. Drag
+Operation Fox Assault to Applications to install. Alternatively,
+double-click on Operation Fox Assault to run it.
 
-Othewise open a terminal / console and "cd" to the game directory and run:
+Source:
 
-  python run_game.py
+If you have obtained the source directly, you need to install the
+dependencies listed further down. Then run "python run_game.py".
 
+HOW TO PLAY THE GAME
+====================
 
+???
 
-HOW TO PLAY THE GAME:
+DEPENDENCIES
+============
+
+You will need to install these before running the game:
 
-Move the cursor around the screen with the mouse.
+  Python:                   http://www.python.org/
+  PyGame:                   http://www.pygame.org/
+  Albow:                    http://www.cosc.canterbury.ac.nz/greg.ewing/python/Albow/
 
-Press the left mouse button to fire the ducks.
+??? requires python 2.5 or later, pygame 1.8 or later and
+Albow 2.1.0.
 
+LICENSE
+=======
 
+MIT License. See COPYING.
 
-LICENSE:
+LINKS
+=====
 
-This game skellington is placed in the Public Domain.
+- http://ctpug.org.za/
+- IRC: #ctpug on Atrum (http://www.atrum.org)
 
+- http://www.pyweek.org/11/
+- IRC: #pyweek on FreeNode
+- http://search.twitter.com/search?q=pyweek