From: W. Trevor King <wking@drexel.edu>
Date: Fri, 26 Mar 2010 06:10:07 +0000 (-0400)
Subject: Added README and renamed risk/ -> pyrisk/
X-Git-Tag: 0.1~32
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=675cecc409f97e0ddf84ae730839d3183793b0e2;p=pyrisk.git

Added README and renamed risk/ -> pyrisk/
---

diff --git a/README b/README
new file mode 100644
index 0000000..0b1f69e
--- /dev/null
+++ b/README
@@ -0,0 +1,53 @@
+PyRisk
+======
+
+This is a Python engine and interface for building games similar to
+Albert Lamorisse's 1957 La Conquête du Monde.  The game is perhaps
+better known as Risk, and is produced by Parker Brothers (now a
+division of Hasbro).
+
+Benefits over other open source implementations:
+
+  * simple, extensible implementation
+  * play-by-email
+
+
+Getting PyRisk
+==============
+
+PyRisk is available as a Git repository::
+
+    $ git clone http://www.physics.drexel.edu/~wking/code/git/pyrisk.git
+
+The most recent commit is also available as a gzipped tarball at::
+
+    http://www.physics.drexel.edu/~wking/code/tar/pyrisk.tgz
+
+Once you get the source, installation is via Docutils::
+
+    pyrisk$ python setup.py build
+    pyrisk$ python setup.py install
+
+
+Getting started
+===============
+
+To setup play-by-email, you'll have to have some method to redirect
+appropriate messages into a named pipe.  With procmail, that will
+look something like::
+
+    :0
+    * ^Subject: *Re:* [PyRisk*
+    | >> /path/to/named/pipe
+
+Then just add your EmailPlayers to your game and go::
+
+    import pyrisk.base as b;
+    import pyrisk.player.email as e;
+    world = generate_earth()
+    players = [EmailPlayer('Alice', 'alice@example.com', 'server@example.com'),
+               EmailPlayer('Bob', 'bob@big.edu', 'server@example.com'),
+               Player('Charlie')]
+    e = Engine(world, players)
+    e.run()
+
diff --git a/risk/__init__.py b/pyrisk/__init__.py
similarity index 100%
rename from risk/__init__.py
rename to pyrisk/__init__.py
diff --git a/risk/base.py b/pyrisk/base.py
similarity index 100%
rename from risk/base.py
rename to pyrisk/base.py
diff --git a/risk/log.py b/pyrisk/log.py
similarity index 100%
rename from risk/log.py
rename to pyrisk/log.py
diff --git a/risk/player/__init__.py b/pyrisk/player/__init__.py
similarity index 100%
rename from risk/player/__init__.py
rename to pyrisk/player/__init__.py
diff --git a/risk/player/email.py b/pyrisk/player/email.py
similarity index 100%
rename from risk/player/email.py
rename to pyrisk/player/email.py