diff --git a/README.md b/README.md index 569e483..afd7c3a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,63 @@ # allioli -The 1914 Allioli Vulgata-Translation + +Read the 1914 Allioli Vulgata-Translation directly in your terminal! + +Code largely based off of [https://github.com/bontibon/kjv.git](https://github.com/bontibon/kjv.git). Luke Smith ([lukesmith.xyz](https://lukesmith.xyz/)) brought my attention to this software via a video of his. + +## Usage + +``` + usage: ./allioli [flags] [reference...] + + -l list books + -W no line wrap + -h show help + + Reference types: + + Individual book + : + Individual chapter of a book + ::[,]... + Individual verse(s) of a specific chapter of a book + :- + Range of chapters in a book + ::- + Range of verses in a book chapter + ::-: + Range of chapters and verses in a book + + / + All verses that match a pattern + / + All verses in a book that match a pattern + :/ + All verses in a chapter of a book that match a pattern +``` + +## Install + +### From Source + +allioli can be built by cloning the repository and then running make: + +```bash + git clone https://github.com/AlexBocken/allioli.git + cd allioli + sudo make install +``` + +## Similar projects + +My work, as already stated, is mostly based on the source code of [Bontibon's kjv](https://github.com/bontibon/kjv). +Similar projects in different variations can be found: + +- My implementation of the Catholic Einheitsübersetzung with footnotes and introductions: https://github.com/AlexBocken/bibel +- Bontibon's original kjv: https://github.com/bontibon/kjv +- Luke's fork with added Apocrypha: https://github.com/LukeSmithxyz/kjv +- Luke's latin version: https://github.com/LukeSmithxyz/vul +- Luke's old greek version: https://github.com/LukeSmithxyz/grb + +## License + +Public domain