Assorted project boilerplate.

[naja.git] / README.txt

diff --git a/README.txt b/README.txt
new file mode 100644 (file)
index 0000000..651b790
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,71 @@
+Codename Naja
+=============
+
+Entry in PyWeek #18  <http://www.pyweek.org/18/>
+
+URL:
+    http://pyweek.org/e/naja
+Team:
+    Naja
+Members:
+    Simon Cross
+    Neil Muller
+    Adrianna Pinska
+    Stefano Rivera
+    David Sharpe
+    Jeremy Thurgood
+License:
+    see LICENSE.txt
+
+
+Requirements
+============
+
+The game requires pygame and pymunk. Requirements can be installed by
+
+  pip install -e .
+
+Or
+
+  pip install -r requirements.txt
+
+It was developed using python 2.7 and pygame 1.9.2. Older versions may or may
+not work.
+
+
+Running the Game
+----------------
+
+On Windows or Mac OS X, locate the "run_game.pyw" file and double-click it.
+
+Othewise open a terminal / console and "cd" to the game directory and run:
+
+  python run_game.py
+
+
+How to Play the Game
+--------------------
+
+There are no ducks.
+
+
+Development notes
+-----------------
+
+Creating a source distribution with::
+
+   ./scripts/build_unix.sh
+
+You may also generate Windows executables and OS X applications::
+
+   python setup.py py2exe
+   python setup.py py2app
+
+Later you might be able to upload files to PyWeek with::
+
+   python pyweek_upload.py
+
+Later you might be able to upload to the Python Package Index with::
+
+   python setup.py register
+   python setup.py sdist upload