jeremy/esv
1
Fork 0
Code Releases Activity

README.md: revise content

Browse source
This commit is contained in:
Jeremy Baxter 2024-06-25 16:04:27 +12:00
parent 6096e01e01
commit 36c520e00f
1 changed files with 17 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

39
README.md
View file

@ -2,12 +2,10 @@
[![builds.sr.ht status](https://builds.sr.ht/~jeremy/esv.svg)](https://builds.sr.ht/~jeremy/esv)
`esv` displays passages of the English Standard Bible on your
terminal. It connects to the ESV web API to retrieve the passages, and
allows configuration through command-line options and the
configuration file.
Example usage:
`esv` displays passages of the English Standard Version of the Bible on
your terminal. It connects to the ESV web API to retrieve the passages,
and allows configuration with command line options and the configuration
file.
```
$ esv Psalm 23
@ -21,25 +19,23 @@ A Psalm of David.
He makes me lie down in green pastures....
```
The names of Bible books are not case sensitive, so John, john, and
JOHN are all accepted.
The names of Bible books are case-insensitive, so John, john,
and JOHN are all accepted.
## Audio
esv supports playing audio passages through the -a option. The
`mpg123` audio/video player is utilised here and so it is required if
you want to play audio passages. If you prefer, you can use a
different player (such as mpv) by editing config.di before compiling.
esv supports playing audio passages through the -a flag. The
mpg123 audio player is used for playing audio by default but
you can set the `ESV_PLAYER` environment variable to something
else such as mpv if you don't have/don't want to use mpg123.
Using the program to play audio is mostly the same as normal text
usage. `esv -a Matthew 5-7` will play an audio passage of Matthew 5-7.
Playing audio is mostly the same as reading a normal text passage.
`esv -a Matthew 5-7` will play an audio passage of Matthew 5-7.
## Installation
To install esv, first make sure you have a D compiler installed on
your system.
ldc, the LLVM D compiler (https://github.com/ldc-developers/ldc#installation)
is recommended but dmd is also supported.
To install esv, first make sure you have a D compiler installed.
LDC is recommended but you can also use DMD.
Commands prefixed with a dollar sign ($) are intended to be run as a
standard user, and commands prefixed with a hash sign (#) are intended
@ -67,10 +63,9 @@ configuration file respectively.
## Copying
Copying, modifying and redistributing this software is permitted as
long as your modified version conforms to the GNU General Public
License version 2.
Copying, modifying and redistributing this software is permitted
under the terms of the GNU General Public License version 2.
Full licenses are contained in the COPYING file.
Full license texts are contained in the COPYING file.
Copyright (c) 2023-2024 Jeremy Baxter