Mercurial > nagslang
annotate README.txt @ 193:d862cc209de4
Add some notes on requirements to the readme
| author | Neil Muller <drnlmuller@gmail.com> |
|---|---|
| date | Tue, 03 Sep 2013 21:53:24 +0200 |
| parents | 1ea8fa09b70f |
| children | 67387621c61b |
| rev | line source |
|---|---|
| 0 | 1 Your Game Title |
| 2 =============== | |
| 3 | |
|
193
d862cc209de4
Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents:
0
diff
changeset
|
4 Entry in PyWeek #17 <http://www.pyweek.org/17/> |
| 0 | 5 URL: http://pyweek.org/e/nagslang |
|
193
d862cc209de4
Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents:
0
diff
changeset
|
6 Team: Cape Viper (leave the "Team: bit") |
| 0 | 7 Members: YOUR TEAM MEMBERS (leave the "Members: bit") |
| 8 License: see LICENSE.txt | |
| 9 | |
|
193
d862cc209de4
Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents:
0
diff
changeset
|
10 Requirements |
|
d862cc209de4
Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents:
0
diff
changeset
|
11 ============ |
|
d862cc209de4
Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents:
0
diff
changeset
|
12 |
|
d862cc209de4
Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents:
0
diff
changeset
|
13 The game requires pygame and pymunk. |
|
d862cc209de4
Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents:
0
diff
changeset
|
14 |
|
d862cc209de4
Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents:
0
diff
changeset
|
15 It was developed using python 2.7, pymunk 4.0 and pygame 1.9.2. Older |
|
d862cc209de4
Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents:
0
diff
changeset
|
16 versions may or may not work. |
|
d862cc209de4
Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents:
0
diff
changeset
|
17 |
|
d862cc209de4
Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents:
0
diff
changeset
|
18 The editor also requires Albow 2.2.0 |
|
d862cc209de4
Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents:
0
diff
changeset
|
19 (from http://www.cosc.canterbury.ac.nz/greg.ewing/python/Albow/) |
|
d862cc209de4
Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents:
0
diff
changeset
|
20 |
| 0 | 21 |
| 22 Running the Game | |
| 23 ---------------- | |
| 24 | |
| 25 On Windows or Mac OS X, locate the "run_game.pyw" file and double-click it. | |
| 26 | |
| 27 Othewise open a terminal / console and "cd" to the game directory and run: | |
| 28 | |
| 29 python run_game.py | |
| 30 | |
| 31 | |
| 32 How to Play the Game | |
| 33 -------------------- | |
| 34 | |
| 35 | |
| 36 | |
| 37 Move the cursor around the screen with the mouse. | |
| 38 | |
| 39 Press the left mouse button to fire the ducks. | |
| 40 | |
| 41 | |
| 42 Development notes | |
| 43 ----------------- | |
| 44 | |
| 45 Creating a source distribution with:: | |
| 46 | |
| 47 python setup.py sdist | |
| 48 | |
| 49 You may also generate Windows executables and OS X applications:: | |
| 50 | |
| 51 python setup.py py2exe | |
| 52 python setup.py py2app | |
| 53 | |
| 54 Upload files to PyWeek with:: | |
| 55 | |
| 56 python pyweek_upload.py | |
| 57 | |
| 58 Upload to the Python Package Index with:: | |
| 59 | |
| 60 python setup.py register | |
| 61 python setup.py sdist upload | |
| 62 |