branch: externals/dired-preview
commit 98815455cb82b4b2557ce7ab46dcc0e48d29823e
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: Protesilaos Stavrou <i...@protesilaos.com>
Simplify README.md, pointing to the manual instead (per 33a27a6)
---
README.md | 38 +-------------------------------------
1 file changed, 1 insertion(+), 37 deletions(-)
diff --git a/README.md b/README.md
index 93f36f7513..ea658ef287 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,7 @@
+ Package name (GNU ELPA): `dired-preview` (⚠️ not available yet;
public testing phase as of 2023-06-25)
++ Official manual: <https://protesilaos.com/emacs/dired-preview>
+ Git repo on SourceHut: <https://git.sr.ht/~protesilaos/dired-preview>
- Mirrors:
+ GitHub: <https://github.com/protesilaos/dired-preview>
@@ -9,40 +10,3 @@
+ Mailing list: <https://lists.sr.ht/~protesilaos/general-issues>
+ Backronym: Directories Invariably Render Everything Decently; PDFs
Require Extra Viewing Instructions for Emacs to Work.
-
-* * *
-
-This is a simple package to automatically preview in a side window the
-file at point in Dired buffers. Preview windows are closed when they
-are no longer relevant, while preview buffers are killed if they have
-not been used for other purposes beside previewing.
-
-Enable the `dired-preview-mode` in the current Dired buffer and then
-perform the regular up/down motions. Those will trigger the preview.
-
-The previewed file is displayed in a side window if its size is below
-the number specified in the user option `dired-preview-max-size`.
-Previews are shown subject to a small delay, per ther user option
-`dired-preview-delay`.
-
-Files matching the `dired-preview-ignored-extensions-regexp` are not
-previewed. The default value of that user option includes multimedia,
-PDFs, and EPUBs.
-
-[ In the future, we may find ways to quickly preview any file type
- without affecting the performance of Emacs. Though `dired-preview`
- is designed to have no external dependencies, so such an ambition
- may not be realisable (e.g. produce a thumbnail out of a video). ]
-
-To set up `dired-preview-mode` in every Dired buffer, set it up thus:
-
-```elisp
-(add-hook 'dired-mode-hook #'dired-preview-mode)
-```
-
-I took inspiration for `dired-preview` from the now unmaintained
-`peep-dired` package by Adam Sokolnicki: <https://github.com/asok/peep-dired>.
-My original plan was to volunteer to maintain `peep-dired` but I
-decided to write it my own way: it was easier for me, plus I can
-implement only what I consider necessary without upsetting existing
-users.
