Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add new README.

  • Loading branch information...
commit 450a753a6c788b1f12495ac4debc3a344da64c07 1 parent 7e4bb90
@Macha authored
Showing with 43 additions and 1 deletion.
  1. +43 −0 README.markdown
  2. +0 −1  README.txt
View
43 README.markdown
@@ -0,0 +1,43 @@
+An implementation of Conway's Game of Life in Python.
+
+Usage
+====
+
+Requirements
+---
+
+* Python 2.7
+* PyGame (for the GUI)
+
+Command Line
+---
+
+Run it using consolegol.py. It takes no arguments. When prompted, enter
+the size of the board (it is square, and the number you enter is used
+for all sides). It will ask you how many turns you wish to run. After
+that, you can run it some more, or you can type '0' to exit.
+
+GUI
+---
+
+Run it using `pygamegol.py <length of sides>`. Alternatively, you may also
+specify a filename to a .rle file of an initial layout as such
+`pygamegol.py 100 glider.rle`. However, it will
+be rejected if it is larger than the length of sides given in the
+command line arguments.
+
+The controls are as follows:
+
+* Left click a cell to toggle it's state (See the bugs section below)
+* Press 's' to toggle slow mode. This slows it down to 1 generation per
+ second.
+* Press 'r' to reset the grid.
+* Press tab to fill the grid randomly.
+
+Known Bugs
+----
+
+* If you choose an uneven length, there will be an area around the edge
+ of the screen that will crash the simulator if clicked on.
+* It is extremely slow for grid sizes > ~150x150 (depending on your
+ computer this may go up or down)
View
1  README.txt
@@ -1 +0,0 @@
-An implementation of Conway's Game of Life in Python.
Please sign in to comment.
Something went wrong with that request. Please try again.