[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/topspace 6df160e026 101/181: Update README.md
From: |
ELPA Syncer |
Subject: |
[elpa] externals/topspace 6df160e026 101/181: Update README.md |
Date: |
Tue, 23 Aug 2022 12:58:38 -0400 (EDT) |
branch: externals/topspace
commit 6df160e0264d5f5684f194071c2c377e0da402fb
Author: Trevor Pogue <trevorpogue@gmail.com>
Commit: GitHub <noreply@github.com>
Update README.md
- Remove extra keywords from slogan to make it more concise
- Add usage section & reorder other sections
- Add link to overlay term
---
README.md | 27 +++++++++++++++------------
1 file changed, 15 insertions(+), 12 deletions(-)
diff --git a/README.md b/README.md
index 324cac9ff2..68b56d15db 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
<h1 align="center"> TopSpace </h1>
-<p align="center">Scroll down & recenter top lines in Emacs / get upper
margins/padding.</p>
+<p align="center">Scroll down & recenter top lines in Emacs.</p>
<!-- cursor -->
@@ -40,6 +40,19 @@ To enable `topspace-mode` globally on startup, add the
following to your Emacs c
```
(global-topspace-mode 1)
```
+# Usage
+### Just install and go
+No new keybindings are required, keep using all your previous scrolling &
recentering commands, except now you can also scroll above the top lines.
+
+# Extra commands
+
+### `topspace-recenter-buffer`
+* Add enough top space in the selected window to center small buffers.
+Top space will not be added if the number of text lines in the buffer is larger
+than or close to the selected window's height.
+Customize `topspace-center-position` to adjust the centering position.
+Customize `topspace-autocenter-buffers` to run this command automatically
+after first opening buffers and after window sizes change.
# Customization
```elisp
@@ -134,19 +147,9 @@ By default this is left empty for users to set with their
own
preferred bindings.")
```
-# Extra commands
-
-### `topspace-recenter-buffer`
-* Add enough top space in the selected window to center small buffers.
-Top space will not be added if the number of text lines in the buffer is larger
-than or close to the selected window's height.
-Customize `topspace-center-position` to adjust the centering position.
-Customize `topspace-autocenter-buffers` to run this command automatically
-after first opening buffers and after window sizes change.
-
# How it works under the hood
-The "upper margin" is created by drawing an overlay before
+The "upper margin" is created by drawing an
[overlay](https://www.gnu.org/software/emacs/manual/html_node/elisp/Overlays.html)
before
window-start containing newline characters. As you scroll above the
top line, more newline characters are added or removed accordingly.
- [elpa] externals/topspace 66373896ec 047/181: Update README.md, (continued)
- [elpa] externals/topspace 66373896ec 047/181: Update README.md, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 1b08e734ec 049/181: Update README.md, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace cbdcdff484 051/181: Fix `recenter-top-bottom` bug, add .md files, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 0d5a7cbc63 055/181: Update README.md, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace cb918d1c44 057/181: Create PULL_REQUEST_TEMPLATE.md, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 9e24080d3a 060/181: Update feature_request.md, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace fda0548e98 061/181: Update bug_report.md, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace abc4a0f8c1 058/181: Update PULL_REQUEST_TEMPLATE.md, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 06316cb9d4 073/181: Update link to include noun, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace effbc9191a 050/181: Update README.md, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 6df160e026 101/181: Update README.md,
ELPA Syncer <=
- [elpa] externals/topspace c749bbfec3 104/181: Update README.md, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace c326169190 110/181: Fix inability to use scrolling commands interactively (#11), ELPA Syncer, 2022/08/23
- [elpa] externals/topspace f47c9f920a 076/181: Add `topspace-active`, improve `topspace-autocenter-buffers`, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 096c5c8ef2 082/181: Fix automatic changelog generation action, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace bd01b69790 085/181: Update PULL_REQUEST_TEMPLATE.md, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace a6469f9e14 086/181: Add user satisfaction survey, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 156dabbe05 070/181: Remove html typo in readme, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 8493ed0687 087/181: Fix bug where topspace-mode doesn't work locally (#6), ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 97c69d912e 088/181: Update Changelog, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 04da9d1b5a 064/181: Create FUNDING.yml, ELPA Syncer, 2022/08/23