From 95ed1b41dd5c1e19bb941472f4a47382b77d261c Mon Sep 17 00:00:00 2001 From: Jeremy Baxter Date: Wed, 30 Apr 2025 22:40:03 +1200 Subject: [PATCH] README: add minimal readme --- README | 13 ++++++++++ README.md | 71 ------------------------------------------------------- 2 files changed, 13 insertions(+), 71 deletions(-) create mode 100644 README delete mode 100644 README.md diff --git a/README b/README new file mode 100644 index 0000000..c92b8b7 --- /dev/null +++ b/README @@ -0,0 +1,13 @@ +This is esv, a program that displays Bible passages on the terminal. + +To build, first install the LDC compiler and libcurl. +Configure the build environment, compile and optionally install: + + $ ./configure + $ make + # make install + +Documentation can be found in the man page esv(1). A quick start guide +is provided at the project's website . + +Written by Jeremy Baxter diff --git a/README.md b/README.md deleted file mode 100644 index 6cc1a3c..0000000 --- a/README.md +++ /dev/null @@ -1,71 +0,0 @@ -## esv - read the Bible from your terminal - -[![builds.sr.ht status](https://builds.sr.ht/~jeremy/esv.svg)](https://builds.sr.ht/~jeremy/esv) - -`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 -Psalm 23 - -The LORD Is My Shepherd - -A Psalm of David. - - The LORD is my shepherd; I shall not want. - He makes me lie down in green pastures.... -``` - -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 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. - -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. -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 -to be run as the root user. - -In [the list of releases][1] select the latest release, and download the -archive with the name esv-X.X.X.tar.gz. After that extract it: - - $ tar -xf esv-*.tar.gz - -Now, compile and install: - - $ cd esv-* - $ ./configure - $ make - # make install - -[1]: https://git.sr.ht/~jeremy/esv/refs - -## Documentation - -All documentation is contained in the manual pages. To access them, -you can run `man esv` and `man esv.conf` for the `esv` utility and the -configuration file respectively. - -## Copying - -Copying, modifying and redistributing this software is permitted -under the terms of the GNU General Public License version 2. - -Full license texts are contained in the COPYING file. - -Copyright (c) 2023-2024 Jeremy Baxter