[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/dired-preview 98815455cb 65/67: Simplify README.md, po
From: |
ELPA Syncer |
Subject: |
[elpa] externals/dired-preview 98815455cb 65/67: Simplify README.md, pointing to the manual instead (per 33a27a6) |
Date: |
Sat, 8 Jul 2023 15:57:56 -0400 (EDT) |
branch: externals/dired-preview
commit 98815455cb82b4b2557ce7ab46dcc0e48d29823e
Author: Protesilaos Stavrou <info@protesilaos.com>
Commit: Protesilaos Stavrou <info@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.
- [elpa] externals/dired-preview d8ba2d0884 11/67: Simplify value of dired-preview-ignored-extensions-regexp, (continued)
- [elpa] externals/dired-preview d8ba2d0884 11/67: Simplify value of dired-preview-ignored-extensions-regexp, ELPA Syncer, 2023/07/08
- [elpa] externals/dired-preview 6bdcc34f68 52/67: Use "below" instead of "bottom" for direction, ELPA Syncer, 2023/07/08
- [elpa] externals/dired-preview 22f44d083c 10/67: Clear previewed buffers after they are killed, ELPA Syncer, 2023/07/08
- [elpa] externals/dired-preview 91fc74d122 49/67: Stop using a side window for previews, ELPA Syncer, 2023/07/08
- [elpa] externals/dired-preview 24bf5bce79 50/67: Add FIXME for dired-preview-display-action-alist-dwim, ELPA Syncer, 2023/07/08
- [elpa] externals/dired-preview 53ebf5d655 51/67: Change how window size is determined (fix 24bf5bc), ELPA Syncer, 2023/07/08
- [elpa] externals/dired-preview 0fa9aab1df 53/67: Add FIXME for how/why window parameters are unset, ELPA Syncer, 2023/07/08
- [elpa] externals/dired-preview ea643a8912 54/67: Simplify dired-preview-trigger, ELPA Syncer, 2023/07/08
- [elpa] externals/dired-preview 4010cc9987 60/67: Implement garbage collection for buffer killing, ELPA Syncer, 2023/07/08
- [elpa] externals/dired-preview 4b89363599 61/67: Delete preview windows, including the selected one, ELPA Syncer, 2023/07/08
- [elpa] externals/dired-preview 98815455cb 65/67: Simplify README.md, pointing to the manual instead (per 33a27a6),
ELPA Syncer <=
- [elpa] externals/dired-preview 6673bb1cd3 67/67: Update to version 0.1.0, ELPA Syncer, 2023/07/08
- [elpa] externals/dired-preview 4da6ee04bf 12/67: Make the display-buffer action alist customisable, ELPA Syncer, 2023/07/08
- [elpa] externals/dired-preview f2a720ca8f 13/67: Update dired-preview-set-up-preview-window doc to reference user option, ELPA Syncer, 2023/07/08
- [elpa] externals/dired-preview 04bfb749c7 22/67: Move two forms closer to where they are used, ELPA Syncer, 2023/07/08
- [elpa] externals/dired-preview 4857868357 33/67: Harden dired-preview--close-previews-outside-dired conditionality, ELPA Syncer, 2023/07/08
- [elpa] externals/dired-preview 38fab3d419 38/67: Use 'file-regular-p' instead of 'file-exists-p', ELPA Syncer, 2023/07/08
- [elpa] externals/dired-preview f6bb0e3271 44/67: Add TODO to only accummulate a fixed size of buffers, ELPA Syncer, 2023/07/08
- [elpa] externals/dired-preview 00ab2337ca 46/67: Stop adding 'no-other-window' parameter, ELPA Syncer, 2023/07/08
- [elpa] externals/dired-preview bac80501c8 55/67: Use 'unless' in dired-preview--close-previews-outside-dired, ELPA Syncer, 2023/07/08
- [elpa] externals/dired-preview d9b779e2da 58/67: Use "-get" instead of "-return" in function symbols, ELPA Syncer, 2023/07/08