[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/guru-mode 81db561 29/42: Clean up the readme a bit
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/guru-mode 81db561 29/42: Clean up the readme a bit |
Date: |
Wed, 11 Aug 2021 09:58:31 -0400 (EDT) |
branch: elpa/guru-mode
commit 81db5611dd29f2c3d9ea91fb7f086a2cf9847553
Author: Bozhidar Batsov <bozhidar@batsov.com>
Commit: Bozhidar Batsov <bozhidar@batsov.com>
Clean up the readme a bit
---
README.md | 35 ++++++++++++++---------------------
1 file changed, 14 insertions(+), 21 deletions(-)
diff --git a/README.md b/README.md
index 8c9b8ab..4cc63ab 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,12 @@
-# Synopsis
+## Synopsis
-Guru mode disables some common keybindings and suggests the use of the
established Emacs alternatives instead.
+Guru mode disables some common keybindings and suggests the use of the
+established Emacs alternatives instead.
-# Installation
+## Installation
+
+### Manual
-## Manual
Just drop `guru-mode.el` somewhere in your `load-path`. I favour the
folder `~/.emacs.d/vendor`:
@@ -13,24 +15,19 @@ folder `~/.emacs.d/vendor`:
(require 'guru-mode)
```
-## Marmalade
-
-If you're an Emacs 24 user or you have a recent version of package.el
-you can install guru-mode from the [Marmalade](http://marmalade-repo.org/)
repository.
-
-## MELPA
+### MELPA
If you're an Emacs 24 user or you have a recent version of package.el
you can install guru-mode from the [MELPA](https://melpa.org/) repository.
-## Emacs Prelude
+### Emacs Prelude
`guru-mode` is naturally part of the
[Emacs Prelude](https://github.com/bbatsov/prelude). If you're a Prelude
user - `guru-mode` is already properly configured and ready for
action.
-# Usage
+## Usage
You can enable `guru-mode` globally like this:
@@ -51,26 +48,22 @@ If you only want to get warnings when you the arrow keys
use the following confi
(setq guru-warn-only t)
```
-# Known issues
+## Known issues
Check out the project's
[issue
list](https://github.com/bbatsov/guru-mode/issues?sort=created&direction=desc&state=open)
a list of unresolved issues. By the way - feel free to fix any of them
and send me a pull request. :-)
-# Contributors
+## Contributors
-Here's a [list](https://github.com/bbatsov/guru-mode/contributors) of all the
people who have contributed to the
-development of guru-mode.
+Here's a [list](https://github.com/bbatsov/guru-mode/contributors) of
+all the people who have contributed to the development of guru-mode.
-# Bugs & Improvements
+## Bugs & Improvements
Bug reports and suggestions for improvements are always
welcome. GitHub pull requests are even better! :-)
-If you like the project, consider supporting its development via
[gittip](https://www.gittip.com/bbatsov).
-
-[![Support via
Gittip](https://rawgithub.com/twolfson/gittip-badge/0.2.0/dist/gittip.png)](https://www.gittip.com/bbatsov)
-
Cheers,<br/>
[Bozhidar](http://twitter.com/bbatsov)
- [nongnu] elpa/guru-mode e91cdfb 40/42: Fix broken badge, (continued)
- [nongnu] elpa/guru-mode e91cdfb 40/42: Fix broken badge, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode 0c0db11 10/42: Removed a duplicated keybinding in the keymap., ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode c0e92da 13/42: use car/cdr instead of first & rest, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode 6f9392f 19/42: Remove a couple of redundant functions, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode e7c3500 22/42: Wrong keybindings, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode 8ee0fcb 24/42: Merge pull request #9 from bkruczyk/fix-delete-key-handling, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode 3274661 36/42: Add a docstring, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode 0aadb72 39/42: Add a few badges, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode fcb13d4 42/42: Tweak some wording, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode 0f8ba29 28/42: Update the copyright, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode 81db561 29/42: Clean up the readme a bit,
ELPA Syncer <=
- [nongnu] elpa/guru-mode 79cd8a3 31/42: Tweak some markup, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode 2db006f 32/42: Bump the copyright years, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode 051e418 33/42: Make guru-warn-only a defcustom, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode 1f50aa9 35/42: [#7] Add a note about modifying the list of keybindings, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode 9d0aff6 38/42: Refactor a bit guru-init, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode 3f5cfcb 41/42: Tweak the README, ELPA Syncer, 2021/08/11