jeremy/esv
1
Fork 0
Code Releases Activity

update readme

Browse source
This commit is contained in:
Jeremy Baxter 2024-02-13 10:24:00 +13:00
parent 49e2606a2e
commit 8881e20178
1 changed files with 33 additions and 40 deletions
Download patch file Download diff file Expand all files Collapse all files

73
README.md
View file

@ -1,10 +1,9 @@
# esv ## esv - read the Bible from your terminal
*Read the Bible from your terminal* `esv` displays passages of the English Standard Bible on your
terminal. It connects to the ESV web API to retrieve the passages, and
`esv` is a utility that displays passages of the English Standard Bible allows configuration through command-line options and the
on your terminal. It connects to the ESV web API to retrieve the passages, configuration file.
and allows configuration through command-line options and the configuration file.
Example usage: Example usage:
@ -20,59 +19,53 @@ A Psalm of David.
He makes me lie down in green pastures.... He makes me lie down in green pastures....
``` ```
The names of Bible books are not case sensitive, so John, john, and JOHN The names of Bible books are not case sensitive, so John, john, and
are all accepted. JOHN are all accepted.
## Audio ## Audio
`esv` supports playing audio passages through the -a option. esv supports playing audio passages through the -a option. The
The `mpg123` audio/video player is utilised here and so it required if you `mpg123` audio/video player is utilised here and so it is required if
want to play audio passages. If you prefer, you can use a different player you want to play audio passages. If you prefer, you can use a
(such as mpv) by editing config.di. different player (such as mpv) by editing config.di before compiling.
Audio usage is the same as normal text usage. `esv -a Matthew 5-7` will play Using the program to play audio is mostly the same as normal text
an audio passage of Matthew 5-7. usage. `esv -a Matthew 5-7` will play an audio passage of Matthew 5-7.
## Installation ## Installation
To install `esv`, first make sure you have the To install esv, first make sure you have a D compiler installed on
[LLVM D compiler (ldc)](https://github.com/ldc-developers/ldc#installation) your system.
installed on your system. ldc, the LLVM D compiler (https://github.com/ldc-developers/ldc#installation)
is recommended but dmd is also supported.
Commands prefixed with a dollar sign ($) are intended to be run as Commands prefixed with a dollar sign ($) are intended to be run as a
a standard user, and commands prefixed with a hash sign (#) are intended standard user, and commands prefixed with a hash sign (#) are intended
to be run as the root user. to be run as the root user.
First, get the source code: First, download the source code:
``` $ git clone https://github.com/jtbx/esv
$ git clone https://codeberg.org/jtbx/esv $ cd esv
$ cd esv
```
Now, compile and install: Now, compile and install:
``` $ ./configure
$ ./configure $ make
$ make # make install
# make install
```
## Documentation ## Documentation
All documentation is contained in the manual pages. To access them, you can run All documentation is contained in the manual pages. To access them,
`man esv` and `man esv.conf` for the `esv` utility and the configuration file respectively. you can run `man esv` and `man esv.conf` for the `esv` utility and the
configuration file respectively.
## Copying ## Copying
Copying, modifying and redistributing this software is permitted Copying, modifying and redistributing this software is permitted as
as long as your modified version conforms to the GNU General Public License version 2. long as your modified version conforms to the GNU General Public
License version 2.
The file esvapi.d is a reusable library; all documentation is provided in the source file. Full licenses are contained in the COPYING file.
The license is contained in the file COPYING. Copyright (c) 2024 Jeremy Baxter
This software uses a modified version of a library named "dini". This is released under
the Boost Software License version 1.0, which can be found in import/dini/LICENSE.
dini can be found at https://github.com/robik/dini.
My changes can be found at https://github.com/jtbx/dini.