diff options
| -rw-r--r-- | python/README | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/python/README b/python/README new file mode 100644 index 0000000..a86d23a --- /dev/null +++ b/python/README @@ -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" |