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) [![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 `esv` displays passages of the English Standard Version of the Bible on
terminal. It connects to the ESV web API to retrieve the passages, and your terminal. It connects to the ESV web API to retrieve the passages,
allows configuration through command-line options and the and allows configuration with command line options and the configuration
configuration file. file.
Example usage:
``` ```
$ esv Psalm 23 $ esv Psalm 23
@ -21,25 +19,23 @@ 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 The names of Bible books are case-insensitive, so John, john,
JOHN are all accepted. and JOHN are all accepted.
## Audio ## Audio
esv supports playing audio passages through the -a option. The esv supports playing audio passages through the -a flag. The
`mpg123` audio/video player is utilised here and so it is required if mpg123 audio player is used for playing audio by default but
you want to play audio passages. If you prefer, you can use a you can set the `ESV_PLAYER` environment variable to something
different player (such as mpv) by editing config.di before compiling. 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 Playing audio is mostly the same as reading a normal text passage.
usage. `esv -a Matthew 5-7` will play an audio passage of Matthew 5-7. `esv -a Matthew 5-7` will play an audio passage of Matthew 5-7.
## Installation ## Installation
To install esv, first make sure you have a D compiler installed on To install esv, first make sure you have a D compiler installed.
your system. LDC is recommended but you can also use DMD.
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 a Commands prefixed with a dollar sign ($) are intended to be run as a
standard user, and commands prefixed with a hash sign (#) are intended standard user, and commands prefixed with a hash sign (#) are intended
@ -67,10 +63,9 @@ configuration file respectively.
## Copying ## Copying
Copying, modifying and redistributing this software is permitted as Copying, modifying and redistributing this software is permitted
long as your modified version conforms to the GNU General Public under the terms of the GNU General Public License version 2.
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 Copyright (c) 2023-2024 Jeremy Baxter