[Assorted-commits] SF.net SVN: assorted: [770] python-afx/trunk/README

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

Revision: 770
          http://assorted.svn.sourceforge.net/assorted/?rev=770&view=rev
Author:   yangzhang
Date:     2008-05-09 00:06:35 -0700 (Fri, 09 May 2008)

Log Message:
-----------
updated readme

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

Modified: python-afx/trunk/README
===================================================================
--- python-afx/trunk/README	2008-05-09 07:06:26 UTC (rev 769)
+++ python-afx/trunk/README	2008-05-09 07:06:35 UTC (rev 770)
@@ -1,5 +1,42 @@
-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-afx
+Overview
+--------
+
+AFX is a library that extends the AF asynchronous programming library.  The
+list of new features includes:
+
+- thread support: call-from-thread and call-in-thread (a la [Twisted])
+- fair queueing
+- condition variables
+- object-pickling socket streams
+- atomic booleans
+- queue control
+- task pools
+- traceback tools
+- startup wrappers
+- simple servers
+
+This extension was started while building [ICEDB].
+
+[Twisted]: http://twistedmatrix.com/
+[ICEDB]: http://cartel.csail.mit.edu/icedb/
+
+Setup
+-----
+
+Requirements:
+
+- AF (unreleased; contact [the author] for more information)
+- [Python Commons] 0.2
+
+[Python Commons]: http://assorted.sf.net/python-commons/
+
+To install, run `setup.py` or `setup.bash`.
+
+Future Work
+-----------
+
+- Substantial reorganization of the code.
+- Code documentation.
+- Test suite.


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