From 1577431725b13892f34bc4c4e4bab69439ac386a Mon Sep 17 00:00:00 2001 From: toonn Date: Mon, 5 Aug 2019 21:31:21 +0200 Subject: Improve the Dependencies section of the README This section was incomplete because `scope.sh` has grown a lot. Fixes #1611 --- README.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 09130ad3..9789902c 100644 --- a/README.md +++ b/README.md @@ -76,23 +76,31 @@ Dependencies Optional: * The `file` program for determining file types -* The Python module `chardet`, in case of encoding detection problems +* `chardet` (Python package) for improved encoding detection of text files * `sudo` to use the "run as root" feature -* `w3m` for the `w3mimgdisplay` program to preview images * `python-bidi` for correct display of RTL file names (Hebrew, Arabic) Optional, for enhanced file previews (with `scope.sh`): * `img2txt` (from `caca-utils`) for ASCII-art image previews +* `w3mimgdisplay`, `ueberzug`, `kitty`, `terminology` or `urxvt` for image + previews +* `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` and/or `unrar` for previews of archives +* `atool`, `bsdtar`, `unrar` and/or `7z` for previews of archives +* `bsdtar`, `tar`, `unrar` and/or `unzip` to preview archives as their first + image * `lynx`, `w3m` or `elinks` for previews of html pages -* `pdftotext` or `mutool` for `pdf` previews +* `pdftotext` or `mutool` for textual `pdf` previews, `pdftoppm` to preview as + image +* `djvutxt` for textual DjVu previews, `ddjvu` to preview as image +* `calibre` or `epub-thumbnailer` for image previews of ebooks * `transmission-show` for viewing BitTorrent information * `mediainfo` or `exiftool` for viewing information about media files * `odt2txt` for OpenDocument text files (`odt`, `ods`, `odp` and `sxw`) -* `chardet` (Python package) for improved encoding detection of text files - +* `python` or `jq` for JSON files +* `fontimage` for font previews Installing ---------- -- cgit 1.4.1-2-gfad0 From 0e0f3467a31de27fe570d9f3a40a7294df6222f5 Mon Sep 17 00:00:00 2001 From: Leo Vivier Date: Mon, 5 Aug 2019 21:53:01 +0200 Subject: Further README improvements MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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’. --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) (limited to 'README.md') 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 -- cgit 1.4.1-2-gfad0 From 977254aafa784bc855510dca81f80f5d148da666 Mon Sep 17 00:00:00 2001 From: toonn Date: Mon, 5 Aug 2019 23:09:42 +0200 Subject: Change phrasing to avoid confusion Don't want people to think "More options" means settings. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index f12f9957..d1e75117 100644 --- a/README.md +++ b/README.md @@ -82,7 +82,7 @@ For general usage: * `sudo` to use the "run as root" feature * `python-bidi` to display right-to-left file names correctly (Hebrew, Arabic) -More options for enhanced file previews (with `scope.sh`): +For enhanced file previews (with `scope.sh`): * `img2txt` (from `caca-utils`) for ASCII-art image previews * `w3mimgdisplay`, `ueberzug`, `kitty`, `terminology` or `urxvt` for image -- cgit 1.4.1-2-gfad0