Use codecs.open to pull the README text into setup.py's long_description.

[pyrisk.git] / README

diff --git a/README b/README
index 6a9b7cf3d6e4d2a9eb0b769cd5c025f4b0357e22..33e32da2dfd2aa570d5ea23a121105cbe50d7f6a 100644 (file)
--- a/README
+++ b/README
@@ -2,9 +2,9 @@ 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).
+the 1957 La Conquête du Monde by Albert Lamorisse (of "Le Ballon rouge
+/ The Red Balloon" fame).  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:
 
@@ -17,11 +17,11 @@ Getting PyRisk
 
 PyRisk is available as a Git repository::
 
-    $ git clone http://www.physics.drexel.edu/~wking/code/git/pyrisk.git
+    $ git clone git://tremily.us/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
+    http://git.tremily.us/?p=pyrisk.git;a=snapshot;h=HEAD;sf=tgz
 
 Once you get the source, installation is via Docutils::
 
@@ -55,11 +55,13 @@ your game and go::
     from pyrisk.base import generate_earth, Player, Engine
     from pyrisk.player.email import IncomingEmailDispatcher, \
         OutgoingEmailDispatcher, EmailPlayer
+    from pyrisk.graphics import WorldRenderer
     world = generate_earth()
     ied = IncomingEmailDispatcher(fifo_path='/tmp/pyrisk.in')
     oed = OutgoingEmailDispatcher(return_address='server@example.com')
-    players = [EmailPlayer('Alice', 'alice@big.edu', ied, oed),
-               EmailPlayer('Bob', 'bob@fish.net', ied, oed),
+    wr = WorldRenderer()
+    players = [EmailPlayer('Alice', 'alice@big.edu', ied, oed, wr),
+               EmailPlayer('Bob', 'bob@fish.net', ied, oed, wr),
                Player('Charlie')]
     e = Engine(world, players)
     e.run()