From db1b4c3f11e7f823629fdc78d7088043f8b9b401 Mon Sep 17 00:00:00 2001 From: Your Name Date: Fri, 6 Nov 2020 12:45:32 -0500 Subject: Updated readme --- readme.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 readme.md (limited to 'readme.md') 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 use specified module + --set-default-module use specified module by default in future runs + --list-books list books available in the current module + --list-chapters 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 +``` -- cgit v1.2.3