[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/topspace 73cb30dc10 028/181: Add more info on how it wo
From: |
ELPA Syncer |
Subject: |
[elpa] externals/topspace 73cb30dc10 028/181: Add more info on how it works to README |
Date: |
Tue, 23 Aug 2022 12:58:30 -0400 (EDT) |
branch: externals/topspace
commit 73cb30dc107d0edd5343553afa9517f16f3d9503
Author: Trevor Pogue <trevorpogue@gmail.com>
Commit: GitHub <noreply@github.com>
Add more info on how it works to README
---
README.md | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index d1159edb01..dc8abb8d92 100644
--- a/README.md
+++ b/README.md
@@ -8,16 +8,22 @@
![topspace](https://user-images.githubusercontent.com/12535207/154770200-0b3edcd8-8036-40c7-910f-d5b3a1c3b4df.gif)
-TopSpace is an Emacs minor mode that lets you scroll above the top line to
vertically center top text.
+TopSpace is an Emacs minor mode that lets you scroll above the top line to
vertically center top text with a scrollable top margin/padding.
+
+### Just install and go:
No new keybindings are required as `topspace` automatically works for any
commands or subsequent function calls which use `scroll-up`, `scroll-down`,
or `recenter` as the underlying primitives for scrolling. This includes all
scrolling commands/functions available in Emacs as far as the author is aware.
+### How it works:
+
+The top "margin" is created by drawing an
[overlay](https://www.gnu.org/software/emacs/manual/html_node/elisp/Overlays.html)
before window-start which contains nothing but newline characters. As you
scroll, more newline characters are added or removed accordingly.
+
Bonus: If you use [`centered-cursor-mode`][1], this means that `topspace` will
automatically let you center the cursor all the way to the top line!
-### Installation
+# Installation
TopSpace is available on [MELPA](http://melpa.org).
After [installing MELPA](https://melpa.org/#/getting-started) you can install
TopSpace with the following command:
- [elpa] externals/topspace 40cf3cfe5f 007/181: Update README.md, (continued)
- [elpa] externals/topspace 40cf3cfe5f 007/181: Update README.md, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 8ce487bd3d 014/181: Merge pull request #1 from trevorpogue/dev, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace f15aea8579 016/181: Remove unused private variables and add .dir-locals.el, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 50aae1cbdd 011/181: Update README.md, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace d8ba41b20e 020/181: Make topspace-enable and topspace-disable private functions, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 694c10574c 012/181: Update topspace.el, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 09d47d32b8 023/181: Add MELPA badge and installation instructions, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 512893f002 021/181: Provide documentation strings for private variables, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 976971f4a9 024/181: Add clarification to Installation steps, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace f36c0e28af 025/181: Add MELPA Stable badge, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 73cb30dc10 028/181: Add more info on how it works to README,
ELPA Syncer <=
- [elpa] externals/topspace 8591032298 029/181: Add to package motivation in README, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace a76d4f3612 031/181: Update to more clear GIF in README, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 4eb27abaa1 034/181: Prevent top space from all suddenly disappearing when visual-line-mode is enabled and cursor scrolls bellow screen with top space present, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 7a3c9703a5 041/181: Fix links in README, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace c6bc481049 042/181: Fix links in README, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 7303661244 043/181: Update headers in README, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace d19151de61 044/181: Refine README, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace ba7eba3d49 046/181: Make README more concise, ELPA Syncer, 2022/08/23
- [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