summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorLeo Vivier <leo.vivier+dev@gmail.com>2019-08-05 21:53:01 +0200
committertoonn <toonn@toonn.io>2019-08-05 23:06:32 +0200
commit0e0f3467a31de27fe570d9f3a40a7294df6222f5 (patch)
tree832d4cb90ec0a4772aa69dc019b96285e5ca5fcd
parent1577431725b13892f34bc4c4e4bab69439ac386a (diff)
downloadranger-0e0f3467a31de27fe570d9f3a40a7294df6222f5.tar.gz
Further README improvements
Do not use article for ‘file’. Rephrase description for ‘python-bidi’.
Create sub-heading for optional dependencies. Mention ‘depencies’ in
the sub-heading, looks a tad barren otherwise. Change ‘General’ to
‘For general usage’. Change ‘for + noun’ to ‘to + verb’.
-rw-r--r--README.md14
1 files changed, 8 insertions, 6 deletions
diff --git a/README.md b/README.md
index 9789902c..f12f9957 100644
--- a/README.md
+++ b/README.md
@@ -73,14 +73,16 @@ Dependencies
   and (optionally) wide-unicode support
 * A pager (`less` by default)
 
-Optional:
+### Optional dependencies
 
-* The `file` program for determining file types
+For general usage:
+
+* `file` for determining file types
 * `chardet` (Python package) for improved encoding detection of text files
 * `sudo` to use the "run as root" feature
-* `python-bidi` for correct display of RTL file names (Hebrew, Arabic)
+* `python-bidi` to display right-to-left file names correctly (Hebrew, Arabic)
 
-Optional, for enhanced file previews (with `scope.sh`):
+More options for enhanced file previews (with `scope.sh`):
 
 * `img2txt` (from `caca-utils`) for ASCII-art image previews
 * `w3mimgdisplay`, `ueberzug`, `kitty`, `terminology` or `urxvt` for image
@@ -88,10 +90,10 @@ Optional, for enhanced file previews (with `scope.sh`):
 * `convert` (from `imagemagick`) to auto-rotate images and for SVG previews
 * `ffmpegthumbnailer` for video thumbnails
 * `highlight` or `pygmentize` for syntax highlighting of code
-* `atool`, `bsdtar`, `unrar` and/or `7z` for previews of archives
+* `atool`, `bsdtar`, `unrar` and/or `7z` to preview archives
 * `bsdtar`, `tar`, `unrar` and/or `unzip` to preview archives as their first
   image
-* `lynx`, `w3m` or `elinks` for previews of html pages
+* `lynx`, `w3m` or `elinks` to preview html pages
 * `pdftotext` or `mutool` for textual `pdf` previews, `pdftoppm` to preview as
   image
 * `djvutxt` for textual DjVu previews, `ddjvu` to preview as image