Less buggy Kivy 1.7 hackery

[erdslangetjie.git] / README.txt

diff --git a/README.txt b/README.txt
index 45794d4a54cc6b621d056f47d0baf2b124e0343e..b6475909a8108dfb79c2be6672ff086d1d8f7cdf 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -1,13 +1,61 @@
-Peter's Thread Snake
-=====================
+Bane's Befuddlement
+===================
 
 Entry in PyWeek #16  <http://www.pyweek.org/16/>
 URL: http://www.pyweek.org/e/erdslangetjie
 Team: erdslangetjie
 Members: Neil Muller (drnlm)
-License: see LICENSE.txt
+License: ICS - see LICENSE.txt
 
 
+Requirements
+------------
+
+This was developed using pygame 1.9.1 and kivy 1.6.0.
+
+Git repo: http://www.ctpug.org.za/gitweb/?p=erdslangetjie.git;a=summary
+
+Installation notes
+------------------
+
+   Linux
+   -----
+
+   For Linux, I created a virtualenv and used pip install kivy to setup the
+   latest kivy environment. Pygame installation didn't work for me using pip,
+   so I used the system packages for that.
+
+   i.e.
+
+   $ virtualenv --system-site-packages ve
+   $ . ve/bin/activate
+   $ pip install -r requirements.txt  # to install kivy and cython
+
+   Windows
+   -------
+
+   The windows zipfile is a stripped down version of the kivy windows
+   portable distribution - http://kivy.googlecode.com/files/Kivy-1.6.0-w32.zip.
+
+   Unzip it and run the included bane_pyweek_16.bat file to run the game.
+
+   Tested on a windows 7 virtula machine.
+
+
+   Android Notes
+   -------------
+
+   The zip file works with the kivy launcher -
+   http://kivy.googlecode.com/files/KivyLauncher-1.6.0.0.apk . Download the
+   file to /mnt/sdcard/kivy, unzip it to it's own directory and then run the
+   kivy launcher. It should list the game as an option to run.
+
+   I unfortunately didn't get find the time to look supporting detecting device
+   rotation or building an apk.
+
+   The android zipfile doesn't include the editor, since I never tested that
+   on android.
+
 Running the Game
 ----------------
 
@@ -18,10 +66,37 @@ Othewise open a terminal / console and "cd" to the game directory and run:
   python run_game.py
 
 
+Game blurb
+----------
+
+Yet again. that annoying superhero has found and destroyed your secret lair.
+
+This time, you were prepared. Your trusty servant, Igor, has laid out a cunning
+maze leading to a secret underwater submarine that will allow you to flee
+without being caught.
+
+Of course, it would have been better if Igor had managed to get the map to you
+before things got compilcated, but the lack of a map is but a minor setback.
+
+
 How to Play the Game
 --------------------
 
-TODO
+Navigate to the map exit before your nemesis catches up with you.
+
+Move using the cursor keys, WASD or by dragging the player sprite with the mouse.
+
+You always start each maze with a small lead, and can use gates to delay your
+pursuer. Your pursuer is relentless, though, so don't take too long deciding
+what to do. 
+
+Options
+------
+
+You can access the settings panel by pressing F1
+
+Note that changing the start level only takes effect on the next run, since we
+don't reload the config when that changes.
 
 
 Development notes