emacs-elpa-diffs
[Top][All Lists]
Advanced

[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. 



reply via email to

[Prev in Thread] Current Thread [Next in Thread]