[Assorted-commits] SF.net SVN: assorted: [565] python-commons/trunk/README

[<yan...@us...>]

Revision: 565
          http://assorted.svn.sourceforge.net/assorted/?rev=565&view=rev
Author:   yangzhang
Date:     2008-03-02 19:24:10 -0800 (Sun, 02 Mar 2008)

Log Message:
-----------
new useful readme!

Modified Paths:
--------------
    python-commons/trunk/README

Modified: python-commons/trunk/README
===================================================================
--- python-commons/trunk/README	2008-03-03 03:23:55 UTC (rev 564)
+++ python-commons/trunk/README	2008-03-03 03:24:10 UTC (rev 565)
@@ -1,5 +1,35 @@
-To install, run setup.py or setup.bash.
+[documentation](doc)
 
-Future releases will come with scripts to build the epydoc API
-documentation, but for now please refer to the project homepage for
-the full documentation: http://assorted.sf.net/python-commons
+Overview
+--------
+
+Python Commons is a general-purpose library for Python. To get a sense of
+what it provides, please glance over the [documentation](doc).
+
+Requirements
+------------
+
+- [Python](http://python.org/) 2.5
+- [setuptools](http://peak.telecommunity.com/DevCenter/setuptools) 0.6
+
+Certain sub-modules have extra requirements:
+
+- `async` requires [Twisted](http://twistedmatrix.com/trac/) 2.5
+- `files` requires [path](http://www.jorendorff.com/articles/python/path/) 2.2
+
+This library has only been tested on Linux.
+
+Setup
+-----
+
+To install, run `easy_install python-commons`, or download the source tarball
+and run `python setup.py install`.
+
+Related Work
+------------
+
+- [ASPN Cookbook]: a valuable repository of Python snippets
+- [AIMA Utilities]: accompaniment to a popular AI textbook
+
+[ASPN Cookbook]: http://aspn.activestate.com/ASPN/Cookbook/Python
+[AIMA Utilities]: http://aima.cs.berkeley.edu/python/utils.py


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