Browse Source

Add README.org to repository

Fred Gilham 8 months ago
parent
commit
eb669c79c1
1 changed files with 35 additions and 0 deletions
  1. 35 0
      README.org

+ 35 - 0
README.org

@@ -0,0 +1,35 @@
+#+TITLE: Diatheke Interface for Bible Browsing in Emacs
+
+* Description
+An Emacs Bible viewing interface utilizing the SWORD project's Diatheke command line program.
+* Dependencies
+~diatheke~ and a Biblical Text module (uses KJV by default)
+* Usage
+- M-x ~bible-open~
+- Invoke from command line as follows (requires installing Ezra SIL font):
+  - emacs -g =150x25 -fn \"Ezra SIL-14\" -f bible-open 
+
+** Keybindings
+- b - Select book
+- c - Select chapter
+- h - Describe mode
+- m - Select module
+- n - Next chapter
+- p - Previous chapter
+- q - Quit window
+- s - Search
+- w - Toggle word study
+- x - Split display
+* Features
+- Chapter-based browsing of the Bible
+- Text Formatting
+  - Red Letters
+  - Strong's Greek (with Lemma)
+  - Strong's Hebrew
+  - Morphology
+- Greek & Hebrew Lexicon definition lookup
+- Morphology lookup
+- Tooltip display of definitions, morphology
+- Searching
+* Example
+[[file:example.png]]