Less buggy Kivy 1.7 hackery

[erdslangetjie.git] / README.txt

diff --git a/README.txt b/README.txt
index 748cea2bd3ec973f4e59235e1fc23ae859d96ca3..b6475909a8108dfb79c2be6672ff086d1d8f7cdf 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -13,6 +13,48 @@ Requirements
 
 This was developed using pygame 1.9.1 and kivy 1.6.0.
 
 
 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
 ----------------
 
 Running the Game
 ----------------


@@ -48,6 +90,14 @@ 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. 
 
 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 
 -----------------
 
 Development notes 
 -----------------