[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/speedrect 7c77c5832f 02/90: Update README.md
From: |
ELPA Syncer |
Subject: |
[elpa] externals/speedrect 7c77c5832f 02/90: Update README.md |
Date: |
Fri, 6 Dec 2024 18:59:07 -0500 (EST) |
branch: externals/speedrect
commit 7c77c5832f2c39cc831ecc488127804cd9041c93
Author: JD Smith <93749+jdtsmith@users.noreply.github.com>
Commit: GitHub <noreply@github.com>
Update README.md
---
README.md | 29 ++++++++++++++++++++++++++++-
1 file changed, 28 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index e43389f9e8..6c9f0b778d 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,29 @@
# speedrect
-Quick key bindings and other tools for rectangle-mark-mode
+Quick key bindings and other tools for Emacs rectangle-mark-mode.
+
+SpeedRect is a small Emacs package that provides convenience "modal" key
bindings and other tools while in `rectangle-mark-mode` (`C-x SPC`, by
default).
+
+## Features
+
+- Key bindings for basic rectangle functions open, insert string, kill,
delete, delete whitespace, clear, copy, yank.
+- Restore the last saved rectangle position, or start a new rectangle from
point.
+- Calc grab and sum commands.
+- Column shift: slide a rectangle left or right, 1 or 5 columns at a time (or
any number, with a prefix).
+- A help page (hit `?`).
+
+## Installation
+
+Just download, add to path, and arrange to `(require 'speedrect)`. For users
of `use-package`:
+
+```elisp
+(use-package speedrect
+ :load-path "~/code/emacs/speedrect") ; or wherever
+```
+
+## Usage
+
+Hit `?` to see the key bindings available.
+
+## Hints
+
+A rectangle is just a _region_ (point and mark), specially interpreted. You
can `C-x C-x` to switch point and mark for easy changes.
- [elpa] externals/speedrect c76e235f30 03/90: Update README.md, (continued)
- [elpa] externals/speedrect c76e235f30 03/90: Update README.md, ELPA Syncer, 2024/12/06
- [elpa] externals/speedrect d165a200ed 06/90: README: add key listing, ELPA Syncer, 2024/12/06
- [elpa] externals/speedrect 36a9ed2a91 07/90: increase doc header bar width, ELPA Syncer, 2024/12/06
- [elpa] externals/speedrect 9c3dfa1a53 09/90: doc: add colon, ELPA Syncer, 2024/12/06
- [elpa] externals/speedrect 1aebd1bf69 10/90: doc: remove extra chars, ELPA Syncer, 2024/12/06
- [elpa] externals/speedrect 5552953cb0 16/90: Update README.md, ELPA Syncer, 2024/12/06
- [elpa] externals/speedrect 4e17571248 17/90: Update README.md, ELPA Syncer, 2024/12/06
- [elpa] externals/speedrect 38ba3c56ff 19/90: doc tweaks, ELPA Syncer, 2024/12/06
- [elpa] externals/speedrect 685478097b 23/90: mention [N]umbers, ELPA Syncer, 2024/12/06
- [elpa] externals/speedrect 8902387c85 28/90: README: describe operation with calc, ELPA Syncer, 2024/12/06
- [elpa] externals/speedrect 7c77c5832f 02/90: Update README.md,
ELPA Syncer <=
- [elpa] externals/speedrect 7f9293882d 04/90: Initial commit, ELPA Syncer, 2024/12/06
- [elpa] externals/speedrect 48dcbdf02c 12/90: use compat to reach older Emacs versions; bump version, ELPA Syncer, 2024/12/06
- [elpa] externals/speedrect 0f7fc6904d 13/90: Update README.md, ELPA Syncer, 2024/12/06
- [elpa] externals/speedrect e8169e86df 15/90: delete-rest: renamed and fixed insertion/end logic, ELPA Syncer, 2024/12/06
- [elpa] externals/speedrect 83a60fa26e 18/90: Update README.md, ELPA Syncer, 2024/12/06
- [elpa] externals/speedrect 9bd1354dee 22/90: Mention straight install, ELPA Syncer, 2024/12/06
- [elpa] externals/speedrect 0ea0dba568 20/90: more doc tweaks, ELPA Syncer, 2024/12/06
- [elpa] externals/speedrect 2aac618746 26/90: speedrect-yank-from-calc: added, ELPA Syncer, 2024/12/06
- [elpa] externals/speedrect f0de893e1a 14/90: kill-rest: added on "r", ELPA Syncer, 2024/12/06
- [elpa] externals/speedrect 1e9b598017 21/90: Update README.md, ELPA Syncer, 2024/12/06