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

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



reply via email to

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