docs: Updated readme

This commit is contained in:
Judah Sotomayor 2024-09-18 08:54:31 -04:00
parent fba5ac850f
commit f156c5a4b7
Signed by: judahsotomayor
SSH Key Fingerprint: SHA256:9Dq4ppxhfAjbX+7HLXEt+ROMiIojI6kqQgUyFUJb9lI

View File

@ -1,13 +1,15 @@
#+title: Readme
* ESV license notes
The ESV license doesn't allow me to distribute copies of the ESV with this project.
I've requested permission, but in the meantime the project will automatically download a copy of the ESV from the [[https://bolls.life/api/][Bolls api]].
Therefore, this project has a derivation to fetch a copy and convert it appropriately.
* Install
* Build
Previous versions of this script used a Makefile.
The current version uses a nix flake, because I wanted practice writing flakes.
#+begin_src shell
git clone https://git.freedomland.xyz/judahsotomayor/esv
cd esv
sudo make install
nix build
#+end_src
* Use