branch: elpa/rainbow-delimiters
commit 406ee45e7c7a0cc58f2dfd8f0f5dea39a71858b4
Author: Fanael Linithien <[email protected]>
Commit: Fanael Linithien <[email protected]>
Rewrite the installation and usage instructions.
---
README.markdown | 63 +++++++++++++++++++++++++++------------------------
rainbow-delimiters.el | 43 +++++++++++++----------------------
2 files changed, 50 insertions(+), 56 deletions(-)
diff --git a/README.markdown b/README.markdown
index a9238a7d61..1847eb0644 100644
--- a/README.markdown
+++ b/README.markdown
@@ -1,45 +1,50 @@
-rainbow-delimiters.el:
-======================
+# rainbow-delimiters
-Rainbow Delimiters is a “rainbow parentheses”-like mode which highlights
parentheses, brackets, and braces according to their depth. Each successive
level is highlighted in a different color. This makes it easy to spot matching
delimiters, orient yourself in the code, and tell which statements are at a
given depth.
+`rainbow-delimiters` is a "rainbow parentheses"-like mode which highlights
+delimiters such as parentheses, brackets or braces according to their depth.
+Each successive level is highlighted in a different color. This makes it easy
to
+spot matching delimiters, orient yourself in the code, and tell which
statements
+are at a given depth.
-Great care has been taken to make this mode fast. You shouldn’t see any change
in scrolling or editing speed when it's on even when working in delimiter-rich
languages like Clojure or Emacs Lisp. It can be used with any language.
+Great care has been taken to make this mode fast. You shouldn't see any change
+in scrolling or editing speed when it's on even when working in delimiter-rich
+languages like Clojure or Emacs Lisp. It can be used with any language.
-You can customize the colors rainbow-delimiters uses. The default colors are
intentionally subtle; they are unobtrusive enough to make the mode worth
looking at even if you usually don’t like rainbow parentheses modes. A number
of major color themes such as Zenburn and Solarized have added their own faces
for the mode.
+You can customize the colors `rainbow-delimiters` uses. The default colors are
+intentionally subtle; they are unobtrusive enough to make the mode worth
looking
+at even if you usually don't like rainbow parentheses modes. A number of major
+color themes such as Zenburn and Solarized have added their own faces for the
+mode.
-This is the official github repository for rainbow-delimiters.
+This is the official github repository for `rainbow-delimiters`.
-The latest <b>release</b> of rainbow-delimiters.el is always found here:
-<br />
-<b>
-*
[rainbow-delimiters.el](http://github.com/Fanael/rainbow-delimiters/raw/master/rainbow-delimiters.el)
-</b>
+The latest **release** of `rainbow-delimiters` is always found at
+(https://github.com/Fanael/rainbow-delimiters/tree/master)
-Further information is available on the [EmacsWiki
page](http://www.emacswiki.org/emacs/RainbowDelimiters):
-<br />
-* http://www.emacswiki.org/emacs/RainbowDelimiters
+## Installation
+The recommended way is to use [MELPA](http://melpa.org/) or
+[MELPA Stable](http://melpa.org/). If either is in your `package-archives`, do
+ M-x package-install RET rainbow-delimiters RET
-Installation instructions:
---------------------------
+Otherwise, open `rainbow-delimiters.el` in Emacs and use
-1. Place rainbow-delimiters.el on your emacs load-path.
+ M-x package-install-from-buffer
-2. Compile the file (necessary for speed):
-<br /><code>M-x byte-compile-file [location of rainbow-delimiters.el]</code>
-3. Add the following to your dot-emacs/init file:
-<br /><code>(require 'rainbow-delimiters)</code>
-4. Activate the mode in your init file.
+Any other methods of installation are unsupported.
+## Usage
-* To enable it only in certain modes, add lines like the following:
-<br /><code>(add-hook 'clojure-mode-hook #'rainbow-delimiters-mode)</code>
+To toggle the mode in the current buffer:
-* To enable it in all programming-related emacs modes (Emacs 24+):
-<br /><code>(add-hook 'prog-mode-hook #'rainbow-delimiters-mode)</code>
+ M-x rainbow-delimiters-mode
-* To toggle rainbow-delimiters mode in an open buffer:
-<br /><code>M-x rainbow-delimiters-mode</code>
+To start the mode automatically in `foo-mode`, add the following to your init
+file:
-Additional discussion is at the top of the file and on the EmacsWiki page
linked to above.
+ (add-hook 'foo-mode-hook #'rainbow-delimiters-mode)
+
+To start the mode automatically in most programming modes (Emacs 24 and above):
+
+ (add-hook 'prog-mode-hook #'rainbow-delimiters-mode)
diff --git a/rainbow-delimiters.el b/rainbow-delimiters.el
index 2d414874d0..0da1c688db 100644
--- a/rainbow-delimiters.el
+++ b/rainbow-delimiters.el
@@ -23,45 +23,35 @@
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <http://www.gnu.org/licenses/>.
-
;;; Commentary:
;;
-;; Rainbow-delimiters is a “rainbow parentheses”-like mode which highlights
+;; Rainbow-delimiters is a "rainbow parentheses"-like mode which highlights
;; parentheses, brackets, and braces according to their depth. Each
;; successive level is highlighted in a different color. This makes it easy
;; to spot matching delimiters, orient yourself in the code, and tell which
;; statements are at a given level.
;;
-;; Great care has been taken to make this mode FAST. You shouldn't see
+;; Great care has been taken to make this mode fast. You shouldn't see
;; any discernible change in scrolling or editing speed while using it,
;; even in delimiter-rich languages like Clojure, Lisp, and Scheme.
-;;
-;; Default colors are subtle, with the philosophy that syntax highlighting
-;; shouldn't be visually intrusive. Color schemes are always a matter of
-;; taste. If you take the time to design a new color scheme, please share
-;; (even a simple list of colors works) on the EmacsWiki page or via github.
-
;;; Installation:
-;; 1. Place rainbow-delimiters.el on your emacs load-path.
-;;
-;; 2. Compile the file (necessary for speed):
-;; M-x byte-compile-file <location of rainbow-delimiters.el>
-;;
-;; 3. Add the following to your dot-emacs/init file:
-;; (require 'rainbow-delimiters)
+;; The recommended way is to use MELPA (http://melpa.org/) or
+;; MELPA Stable (http://melpa.org/). If either is in your `package-archives',
do
+;; M-x package-install RET rainbow-delimiters RET
+;; Otherwise, open `rainbow-delimiters.el' in Emacs and use
+;; M-x package-install-from-buffer
+;; Any other methods of installation are unsupported.
;;
-;; 4. Activate the mode in your init file.
-;;
-;; - To enable it only in certain modes, add lines like the following:
-;; (add-hook 'clojure-mode-hook #'rainbow-delimiters-mode)
-;;
-;; - To enable it in all programming-related emacs modes (Emacs 24+):
-;; (add-hook 'prog-mode-hook #'rainbow-delimiters-mode)
-;;
-;; - To toggle rainbow-delimiters mode in an open buffer:
-;; M-x rainbow-delimiters-mode
+;; To toggle the mode in the current buffer:
+;; M-x rainbow-delimiters-mode
+;; To start the mode automatically in `foo-mode', add the following to your
init
+;; file:
+;; (add-hook 'foo-mode-hook #'rainbow-delimiters-mode)
+;; To start the mode automatically in most programming modes (Emacs 24 and
+;; above):
+;; (add-hook 'prog-mode-hook #'rainbow-delimiters-mode)
;;; Customization:
@@ -114,7 +104,6 @@ Delimiters in this list are not highlighted."
:type '(repeat character)
:group 'rainbow-delimiters)
-
;;; Faces:
;; Unmatched delimiter face:
