git » pytipc » commit 12ec04c

Add a README file.

author Alberto Bertogli
2007-12-15 18:15:23 UTC
committer Alberto Bertogli
2007-12-15 18:45:47 UTC
parent 67f1128c5820bfe1ede446a3544d825e2fa4a066

Add a README file.

Signed-off-by: Alberto Bertogli <albertito@gmail.com>

README +25 -0

diff --git a/README b/README
new file mode 100644
index 0000000..d346e79
--- /dev/null
+++ b/README
@@ -0,0 +1,25 @@
+
+pytipc - A TIPC module for Python
+Alberto Bertogli (albertito@gmail.com)
+---------------------------------------------------
+
+TIPC (http://tipc.sf.net) is a network protocol designed for use in clustered
+computer environments, allowing designers to create applications that can
+communicate quickly and reliably with other applications regardless of their
+location within the cluster.
+
+This project provides a way to use TIPC inside Python using a socket-alike
+interface.
+
+Hopefully, TIPC support will be incorporated into the Python socket module
+sometime in the future and this project will no longer be necessary; but until
+then, here it is.
+
+Most documentation is in the form of docstrings inside the code; but the
+structure and usage is quite similar to the "socket" module.
+
+To install the module, use the standard "python setup.py install" procedure.
+
+Please send any questions, comments or suggestions to albertito@gmail.com.
+The website for this project is http://auriga.wearlab.de/~alb/pytipc/.
+