annotate README.txt @ 139:880e9fa337f3

Move sources out of 'data' into top level 'sources' directory
author Stefano Rivera <stefano@rivera.za.net>
date Tue, 05 Apr 2011 10:03:53 +0200
parents 80472fc8f24d
children df7dc1fdf8c4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
138
80472fc8f24d Update README and LICENCE
Stefano Rivera <stefano@rivera.za.net>
parents: 3
diff changeset
1 Nine Tales
80472fc8f24d Update README and LICENCE
Stefano Rivera <stefano@rivera.za.net>
parents: 3
diff changeset
2 ==========
0
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
3
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
4 Entry in PyWeek #12 <http://www.pyweek.org/12/>
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
5 URL: http://pyweek.org/e/skaapsteker
138
80472fc8f24d Update README and LICENCE
Stefano Rivera <stefano@rivera.za.net>
parents: 3
diff changeset
6 Team: Skaapsteker
80472fc8f24d Update README and LICENCE
Stefano Rivera <stefano@rivera.za.net>
parents: 3
diff changeset
7 Members: Adrianna Pinska, Anna Malczyk, Jeremy Thurgood, Neil Muller,
80472fc8f24d Update README and LICENCE
Stefano Rivera <stefano@rivera.za.net>
parents: 3
diff changeset
8 Oliver Hambsch, Simon Cross, Stefano Rivera
80472fc8f24d Update README and LICENCE
Stefano Rivera <stefano@rivera.za.net>
parents: 3
diff changeset
9 License: MIT, see LICENSE.txt
0
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
10
3
f0c108bee0b2 Supporting Python 2.[67]
Stefano Rivera <stefano@rivera.za.net>
parents: 1
diff changeset
11 Dependancies
f0c108bee0b2 Supporting Python 2.[67]
Stefano Rivera <stefano@rivera.za.net>
parents: 1
diff changeset
12 ------------
f0c108bee0b2 Supporting Python 2.[67]
Stefano Rivera <stefano@rivera.za.net>
parents: 1
diff changeset
13
f0c108bee0b2 Supporting Python 2.[67]
Stefano Rivera <stefano@rivera.za.net>
parents: 1
diff changeset
14 Python >= 2.6 (not Python 3)
138
80472fc8f24d Update README and LICENCE
Stefano Rivera <stefano@rivera.za.net>
parents: 3
diff changeset
15 pygame >= 1.8
0
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
16
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
17 Running the Game
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
18 ----------------
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
19
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
20 On Windows or Mac OS X, locate the "run_game.pyw" file and double-click it.
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
21
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
22 Othewise open a terminal / console and "cd" to the game directory and run:
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
23
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
24 python run_game.py
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
25
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
26
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
27 How to Play the Game
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
28 --------------------
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
29
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
30
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
31
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
32 Move the cursor around the screen with the mouse.
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
33
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
34 Press the left mouse button to fire the ducks.
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
35
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
36
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
37 Development notes
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
38 -----------------
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
39
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
40 Creating a source distribution with::
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
41
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
42 python setup.py sdist
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
43
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
44 You may also generate Windows executables and OS X applications::
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
45
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
46 python setup.py py2exe
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
47 python setup.py py2app
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
48
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
49 Upload files to PyWeek with::
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
50
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
51 python pyweek_upload.py
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
52
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
53 Upload to the Python Package Index with::
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
54
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
55 python setup.py register
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
56 python setup.py sdist upload
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
57