From 8881e201783a10e45ae05409e8518d274dca0ec1 Mon Sep 17 00:00:00 2001
From: Jeremy Baxter <jeremy@baxters.nz>
Date: Tue, 13 Feb 2024 10:24:00 +1300
Subject: [PATCH] update readme

---
 README.md | 73 +++++++++++++++++++++++++------------------------------
 1 file changed, 33 insertions(+), 40 deletions(-)

diff --git a/README.md b/README.md
index c3b8b74..536af6a 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,9 @@
-# esv
+## esv - read the Bible from your terminal
 
-*Read the Bible from your terminal*
-
-`esv` is a utility that 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.
+`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:
 
@@ -20,59 +19,53 @@ 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 not case sensitive, 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 required if you
-want to play audio passages. If you prefer, you can use a different player
-(such as mpv) by editing config.di.
+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.
 
-Audio usage is the same as normal text usage. `esv -a Matthew 5-7` will play
-an audio passage of Matthew 5-7.
+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.
 
 ## Installation
 
-To install `esv`, first make sure you have the
-[LLVM D compiler (ldc)](https://github.com/ldc-developers/ldc#installation)
-installed on your system.
+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.
 
-Commands prefixed with a dollar sign ($) are intended to be run as
-a standard user, and commands prefixed with a hash sign (#) are intended
+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.
 
-First, get the source code:
+First, download the source code:
 
-```
-$ git clone https://codeberg.org/jtbx/esv
-$ cd esv
-```
+    $ git clone https://github.com/jtbx/esv
+    $ cd esv
 
 Now, compile and install:
 
-```
-$ ./configure
-$ make
-# make install
-```
+    $ ./configure
+    $ make
+    # make install
 
 ## 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.
+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
-as long as your modified version conforms to the GNU General Public License version 2.
+Copying, modifying and redistributing this software is permitted as
+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.
-
-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.
+Copyright (c) 2024 Jeremy Baxter