[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/topspace 40cf3cfe5f 007/181: Update README.md
From: |
ELPA Syncer |
Subject: |
[elpa] externals/topspace 40cf3cfe5f 007/181: Update README.md |
Date: |
Tue, 23 Aug 2022 12:58:28 -0400 (EDT) |
branch: externals/topspace
commit 40cf3cfe5faac80134b4f38d139c66988cd36226
Author: Trevor Pogue <poguete@mcmaster.ca>
Commit: GitHub <noreply@github.com>
Update README.md
---
README.md | 50 +++++++++++++++++++++++++++-----------------------
1 file changed, 27 insertions(+), 23 deletions(-)
diff --git a/README.md b/README.md
index beab3b343d..df63e561dd 100644
--- a/README.md
+++ b/README.md
@@ -1,36 +1,40 @@
-# vertical-center-mode
-### An Emacs minor-mode
-Automatically center buffers vertically in the window after opening files and
during editing. Users can also adjust the centering offset with scrolling to
further scroll up or down by any amount **above** the top lines in a buffer.
+# TopSpace
+**Scroll above the top line**
-Scrolling is currently supported when using
`scroll-down-line`/`scroll-up-line`, or
`evil-scroll-line-up`/`evil-scroll-line-down`.
+![topspace](https://user-images.githubusercontent.com/12535207/154770200-0b3edcd8-8036-40c7-910f-d5b3a1c3b4df.gif)
-Scrolling also integrates well with `centered-cursor-mode`, allowing the
cursor to stay centered all the way to the top line when moving the cursor with
`previous-line` and `next-line`.
-# Installation
-Save the file from this repository named `"vertical-center-mode.el"` into a
directory of your choice, then add the following lines to your [`.emacs`][1]
file if not using Spacemacs:
+Topspace is an emacs minor mode that lets you scroll above the top line to
vertically center top text.
+'
+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 that the author is aware of.
- (setq load-path (append load-path "<directory>"))
- (require 'vertical-center-mode)
+Bonus: If you use [`centered-cursor-mode`][3], this means that `topspace` will
automatically let you center the cursor all the way to the top line!
-If using Spacemacs, add the following to your `dotspacemacs/user-config`:
-```
-(eval-when-compile
- (add-to-list 'load-path "<directory>")
- (require 'use-package))
-(use-package vertical-center-mode)
-```
+<!-- # Installation -->
+<!-- Save the file from this repository named `"topspace.el"` into a directory
of your choice, then install it using [`use-package`][2] by adding the
following lines to your [`init file`][1]: -->
-Above, `<directory>` should be the path to the directory in which you saved
the `"vertical-center-mode.el"` file.
+<!-- ``` -->
+<!-- (use-package topspace :load-path "<directory>") -->
+<!-- ``` -->
-# Usage
-After restarting Emacs, you can now activate or deactivate the mode by typing
<kbd>M-x vertical-center-mode</kbd>.
+<!-- Above, `<directory>` should be the path to the directory in which you
saved the `"topspace.el"` file. -->
-You can also globally enable the minor mode either manually by typing <kbd>M-x
global-vertical-center-mode</kbd>, or on init by adding the following to your
init file:
+<!-- # Usage -->
+<!-- After restarting Emacs, you can now activate or deactivate the mode by
typing <kbd>M-x topspace-mode</kbd>. -->
-`(global-vertical-center-mode 1)`
+<!-- You can also globally enable the minor mode either manually by typing
<kbd>M-x global-topspace-mode</kbd>, or on init by changing the `use-package`
code to the following to your init file: -->
+
+<!-- ``` -->
+<!-- (use-package topspace -->
+<!-- :load-path "<directory>" -->
+<!-- :config (global-topspace-mode)) -->
+<!-- ``` -->
-# Contributions
-The initial implementation ideas and name for this minor-mode originated from
[this answer](https://stackoverflow.com/a/66678124/3705784) in a Stack Overflow
thread.
[1]: https://www.gnu.org/software/emacs/manual/html_node/emacs/Init-File.html
+ [2]: https://github.com/jwiegley/use-package
+ [3]: https://github.com/emacsmirror/centered-cursor-mode
- [elpa] branch externals/topspace created (now fa67b67e1a), ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 79aa4e78d3 001/181: Initial commit, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace ca7a6ba61a 004/181: fixed typo in README instruction, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace a4e61e164a 008/181: Update README.md, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 42353585e0 005/181: Minor code improvements from the "low hanging fruit" in initial commit:, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 40cf3cfe5f 007/181: Update README.md,
ELPA Syncer <=
- [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, 2022/08/23