[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/substitute b73b62df77 10/39: Add initial version of the
From: |
ELPA Syncer |
Subject: |
[elpa] externals/substitute b73b62df77 10/39: Add initial version of the README |
Date: |
Mon, 16 Jan 2023 11:58:48 -0500 (EST) |
branch: externals/substitute
commit b73b62df770ed6a685bbc83d64ce4da49d37f75d
Author: Protesilaos Stavrou <info@protesilaos.com>
Commit: Protesilaos Stavrou <info@protesilaos.com>
Add initial version of the README
---
README.md | 35 +++++++++++++++++++++++++++++++++++
1 file changed, 35 insertions(+)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..0af9cfae6a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# Substitute (substitute.el)
+
+⚠️ WORK-IN-PROGRESS ⚠️
+
+Efficiently replace targets in the buffer or context.
+
+Sample configuration:
+
+```elisp
+(require 'substitute)
+
+;; If you like visual feedback on matching target. Default is nil.
+(setq substitute-highlight t)
+
+;; If you want a message reporting the matches that changed. We don't
+;; do it by default
+(add-hook 'substitute-post-replace-hook #'substitute-report-operation)
+
+;; We do not bind any keys. This is just an idea. The mnemonic is
+;; that M-# (or M-S-3) is close to M-% (or M-S-5).
+(let ((map global-map))
+ (define-key map (kbd "M-# s") #'substitute-target-below-point)
+ (define-key map (kbd "M-# r") #'substitute-target-above-point)
+ (define-key map (kbd "M-# d") #'substitute-target-in-function)
+ (define-key map (kbd "M-# M-#") #'substitute-target))
+```
+
++ Package name (GNU ELPA): `substitute` (not available yet)
++ Git repo on SourceHut: <https://git.sr.ht/~protesilaos/substitute>
+ - Mirrors:
+ + GitHub: <https://github.com/protesilaos/substitute>
+ + GitLab: <https://gitlab.com/protesilaos/substitute>
++ Mailing list: <https://lists.sr.ht/~protesilaos/general-issues>
++ Backronym: Some Utilities Built to Substitute Things Independent of
+ Their Utterances, Thoroughly and Easily.
- [elpa] branch externals/substitute created (now 731cb688e2), ELPA Syncer, 2023/01/16
- [elpa] externals/substitute 2eedda90bf 02/39: Add COPYING and gitignore, ELPA Syncer, 2023/01/16
- [elpa] externals/substitute 511a45bbbc 01/39: Add initial version of substitute.el (WORK-IN-PROGRESS), ELPA Syncer, 2023/01/16
- [elpa] externals/substitute e5a012fd15 03/39: Reference correct symbol in doc string, ELPA Syncer, 2023/01/16
- [elpa] externals/substitute 8b1d32af46 04/39: Use pretty target in substitute-report-operation, ELPA Syncer, 2023/01/16
- [elpa] externals/substitute 87fc9cb145 05/39: Abstract positioning and fix issues with targeting, ELPA Syncer, 2023/01/16
- [elpa] externals/substitute fd60c0da63 08/39: Mention substitute-report-operation in hook doc string, ELPA Syncer, 2023/01/16
- [elpa] externals/substitute b73b62df77 10/39: Add initial version of the README,
ELPA Syncer <=
- [elpa] externals/substitute fd991c2e8c 07/39: Tweak one doc string format, ELPA Syncer, 2023/01/16
- [elpa] externals/substitute ff63ce986f 06/39: Use more descriptive name for local variable, ELPA Syncer, 2023/01/16
- [elpa] externals/substitute deb7d28b9e 09/39: Change substitute-highlight default value and fix typo, ELPA Syncer, 2023/01/16
- [elpa] externals/substitute 3c91a4a100 12/39: Define aliases for two commands, ELPA Syncer, 2023/01/16
- [elpa] externals/substitute 11b4277bfe 13/39: Remove obsolete symbol from doc strings, ELPA Syncer, 2023/01/16
- [elpa] externals/substitute cdb23ab35c 17/39: Reference blog post in the README, ELPA Syncer, 2023/01/16
- [elpa] externals/substitute e90152fc90 18/39: Bump version for package-vc-rebuild to do its job, ELPA Syncer, 2023/01/16
- [elpa] externals/substitute e55a121666 25/39: Make minor formatting change, ELPA Syncer, 2023/01/16
- [elpa] externals/substitute be5b7f3e71 11/39: Streamline all commands with a macro, ELPA Syncer, 2023/01/16
- [elpa] externals/substitute a1382f1860 19/39: Tweak substitute backronym, ELPA Syncer, 2023/01/16