diff options
| author | Your Name <you@example.com> | 2020-11-06 12:45:32 -0500 |
|---|---|---|
| committer | Your Name <you@example.com> | 2020-11-06 12:45:32 -0500 |
| commit | db1b4c3f11e7f823629fdc78d7088043f8b9b401 (patch) | |
| tree | 949e431305cdfa29cc665080e8d2c8c1f990779b | |
| parent | 2fe897e2cf750339a7e466aeafe64f45fb650f10 (diff) | |
| download | libbible-db1b4c3f11e7f823629fdc78d7088043f8b9b401.tar.gz libbible-db1b4c3f11e7f823629fdc78d7088043f8b9b401.tar.bz2 libbible-db1b4c3f11e7f823629fdc78d7088043f8b9b401.zip | |
Updated readme
| -rw-r--r-- | readme | 1 | ||||
| -rw-r--r-- | readme.md | 50 |
2 files changed, 50 insertions, 1 deletions
@@ -1 +0,0 @@ -This library provides a simplified interface to the SWORD project. diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..f366d49 --- /dev/null +++ b/readme.md @@ -0,0 +1,50 @@ +#Libbible + +This library provides a simplified interface to the SWORD project. + +##libbible.so + +The library can be compiled into a sharable object file and installed to the system. This is the default make option: + +``` +make +sudo make install +``` + +The full interface is available in libbible.h. + +##bible + +An example cli is included with libbible, which can be compiled using: + +``` +make bible +``` + +The interface is simplistic, and uses a subset of libbible's functionality: + +``` +./bible --help + +Usage: + bible [options] [reference] + +Print bible passages. + +Options: + -h, --help display this help message + --list-modules list all installed modules + -m, --module <mod> use specified module + --set-default-module <mod> use specified module by default in future runs + --list-books list books available in the current module + --list-chapters <book> list chapters available in book in the current module + -o, --omit-verse-numbers when printing verse text, skip printing verse and chapter numbers + + +Examples: + bible Gal 5:22-23 + bible John 3:16 + bible Romans 12 + bible Matt 5:3-7:27 + bible Genesis 1-3 +``` |