[sword-svn] r99 - trunk/python

[lukeplant at www.crosswire.org]

Author: lukeplant
Date: 2007-10-05 06:35:04 -0700 (Fri, 05 Oct 2007)
New Revision: 99

Added:
   trunk/python/README
Log:
Added a README for the python library


Added: trunk/python/README
===================================================================
--- trunk/python/README	                        (rev 0)
+++ trunk/python/README	2007-10-05 13:35:04 UTC (rev 99)
@@ -0,0 +1,25 @@
+Description
+-----------
+
+This directory contains a library of miscellaneous Sword-related Python code
+that is used by Python scripts within this repository.  There is currently
+no official release for this code, and no guarantee of backwards
+compatibility, so if you want to use this library and continue to use later
+versions, PLEASE ADD YOUR CODE to the repository, and LIST IT below.  Anyone
+making breaking changes to the library should ensure that the listed
+projects are changed accordingly.
+
+Projects
+--------
+
+Projects using this code (which also act as documentation on how to use it):
+
+In ../modules/calvinscommentaries:
+  combine_calcom.py
+
+
+Usage
+-----
+
+Ensure the directory containing this README is on your PYTHONPATH.  Import
+it in the normal way e.g. "import swordutils"