Update readme with latest notes
[erdslangetjie.git] / README.txt
index b6b8268604a9f399db307e08e0d5eda3a9fc24db..b6475909a8108dfb79c2be6672ff086d1d8f7cdf 100644 (file)
@@ -18,15 +18,43 @@ Git repo: http://www.ctpug.org.za/gitweb/?p=erdslangetjie.git;a=summary
 Installation notes
 ------------------
 
-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.
+   Linux
+   -----
 
-i.e.
+   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.
 
-$ virtualenv --system-site-packages ve
-$ . ve/bin/activate
-$ pip install -r requirements.txt  # to install kivy and cython
+   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
 ----------------