aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d34ad63
--- /dev/null
+++ b/README.md
@@ -0,0 +1,9 @@
+# Phelpsify
+
+This tool is made to link all Bahá'í prayers together across
+all languages using the code from Phelps' catalog or a derivative
+of this when the prayer is a subpart of a work from the catalog.
+
+Just compile and run the tool with a rel/ directory containing
+code.list and lang.csv. The tool will update the code.list while
+you are working. To help the project, pick languages you can match, try to find the right prayer using keyword search, and when done send your updated code.list to the project so it can be merged in. \ No newline at end of file