[Pybridge-commits] SF.net SVN: pybridge: [445] trunk/pybridge

[<umg...@us...>]

Revision: 445
          http://svn.sourceforge.net/pybridge/?rev=445&view=rev
Author:   umgangee
Date:     2007-06-22 08:50:38 -0700 (Fri, 22 Jun 2007)

Log Message:
-----------
Enhance documentation for 0.3.0.

Modified Paths:
--------------
    trunk/pybridge/INSTALL
    trunk/pybridge/README

Modified: trunk/pybridge/INSTALL
===================================================================
--- trunk/pybridge/INSTALL	2007-06-22 15:42:48 UTC (rev 444)
+++ trunk/pybridge/INSTALL	2007-06-22 15:50:38 UTC (rev 445)
@@ -2,25 +2,52 @@
 ===================
 
 If you want to install PyBridge, change to the directory where you unpacked the
-tarball, then type (as root):
+source tarball, then type (as root):
 
 python setup.py install
 
-Alternatively, you can run PyBridge from the extracted tarball. Change to the
-PyBridge "bin/" directory, then type "./pybridge" to run the client, or
-"./pybridge-server" to run the game server.
+We recommend that, if your distribution provides PyBridge packages, you should
+install from packages. Packages are available for Debian GNU/Linux and its
+derivatives (including Ubuntu) thanks to David Watson <dw...@de...>.
 
+Alternatively, you can run PyBridge from the extracted tarball archive. Change
+to the PyBridge "bin/" directory, then type "./pybridge" to run the graphical
+client, or "./pybridge-server" to run the standalone server.
 
+
 Requirements
 ============
 
-You'll need the following software installed to run PyBridge:
+You will need the following software installed to run PyBridge:
 
-- Python (>= 2.3) - http://www.python.org/
-- Twisted Core (>= 1.3) - http://twistedmatrix.com/trac/wiki/TwistedCore
-- Zope Interface (>= 3.0) - http://www.zope.org/Products/ZopeInterface
-- GTK+ (>= 2.6, >= 2.8 recommended) - http://www.gtk.org/
-- PyGTK (>= 2.6, >= 2.8 recommended) - http://www.pygtk.org/
+  - Python (>= 2.4) - http://www.python.org/
+  - Twisted Core (>= 2.0) - http://twistedmatrix.com/trac/wiki/TwistedCore
+  - Zope Interface (>= 3.0) - http://www.zope.org/Products/ZopeInterface
 
-(The GTK+ and PyGTK libraries are not necessary to run the standalone server.)
 
+To run the PyBridge client, the following software is also required:
+
+  - GTK+ (>= 2.8) - http://www.gtk.org/
+  - PyGTK (>= 2.8) - http://www.pygtk.org/
+  - Cairo (>= 1.0) - http://cairographics.org/
+  - PyCairo (>= 1.0) - http://cairographics.org/pycairo/
+  - ConfigObj (>= 4.0) -http://www.voidspace.org.uk/python/configobj.html 
+
+
+To run the standalone PyBridge server, the following software is also required:
+
+  - SQLObject (>= 0.7) - http://www.sqlobject.org/
+  - A database server compatible with SQLObject: see "Configuring the Server".
+
+
+Configuring the Server
+======================
+
+By default, the standalone server creates and uses a SQLite database in the
+~/.pybridge/ directory. This is suitable for hosting LAN games, but if you wish
+to operate a high-load PyBridge server on the Internet, it may be necessary
+to switch to an external RDBMS, such as MySQL or PostgreSQL.
+
+To change the database settings, edit the ~/.pybridge/server.cfg file. The
+fields to change are documented in the pybridge/server/config.py module.
+

Modified: trunk/pybridge/README
===================================================================
--- trunk/pybridge/README	2007-06-22 15:42:48 UTC (rev 444)
+++ trunk/pybridge/README	2007-06-22 15:50:38 UTC (rev 445)
@@ -1,13 +1,16 @@
-PyBridge 0.2.1 - a free online bridge game
+PyBridge 0.3.0 - a free online bridge game
 http://pybridge.sourceforge.net/
 http://sourceforge.net/projects/pybridge/
 
 
+About PyBridge
+==============
+
 PyBridge allows you to play the card game of (contract) bridge, with human
 players, over the Internet or a local network.
 
 There are many Web resources for learning to play bridge. A good starting point
-is the Wikipedia: see http://en.wikipedia.org/wiki/Contract_bridge .
+is the Wikipedia: see http://en.wikipedia.org/wiki/Contract_bridge.
 
 
 Release Notes
@@ -15,10 +18,10 @@
 
 To use PyBridge, you need to connect to a game server. You have two options:
 
-- Connect to a public server. A list of known public servers can be found on
-  the project website.
+  - Connect to a public server. A list of known public servers can be found on
+    the project website.
 
-- Run a game server yourself, with the pybridge-server script.
+  - Run a game server yourself, using the pybridge-server script.
 
 When connecting to a server for the first time, you need to ensure that the
 "Register as New User" checkbox is ticked.


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.