branch: elpa/rainbow-delimiters
commit 3482ea5ced6f0fe97958a107bbc72ccbbebb75c7
Author: Jeremy L. Rayman <[email protected]>
Commit: Jeremy L. Rayman <[email protected]>
Update README to link to the appropriate locations at EmacsWiki.
---
README | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 50 insertions(+)
diff --git a/README b/README
index e69de29bb2..4f7ae2e421 100644
--- a/README
+++ b/README
@@ -0,0 +1,50 @@
+
+rainbow-delimiters.el:
+======================
+
+Rainbow-delimiters is a "rainbow parentheses"-like Emacs mode for coloring
parentheses, brackets, and braces according to their nested depth. It gives a
visual reference for which delimiters match, and what statements are at the
same depth - if several statements are at the same level, they will be the same
color.
+
+This is the official github repository for rainbow-delimiters. It is made
available so people can easily contribute to the mode. The latest version of
rainbow-delimiters.el is always found at the following location on EmacsWiki:
+http://www.emacswiki.org/emacs/download/rainbow-delimiters.el
+
+Further information is available on the EmacsWiki page:
+http://www.emacswiki.org/emacs/RainbowDelimiters
+
+
+
+Installation instructions:
+--------------------------
+
+1. Place rainbow-delimiters.el on your emacs load-path.
+
+2. Compile the file (necessary for speed):
+```lisp
+M-x byte-compile-file <location of rainbow-delimiters.el>
+'''
+3. Add the following to your dot-emacs/init file:
+```lisp
+(require 'rainbow-delimiters)
+'''
+4. Add hooks for modes where you want it enabled, for example:
+```lisp
+(add-hook 'clojure-mode-hook 'rainbow-delimiters-mode)
+'''
+- To activate rainbow-delimiters mode temporarily in a buffer:
+```lisp
+M-x rainbow-delimiters-mode
+'''
+
+5. When using a dark background, if delimiter colors seem washed out
+you may need to add the following to your dot-emacs and restart:
+```lisp
+(setq-default 'frame-background-mode 'dark)
+'''
+
+This is because Emacs can guess frame-background-mode incorrectly,
+causing rainbow-delimiters to use its light color scheme on dark
+backgrounds.
+
+The light/dark color schemes differ only in their brightness level.
+
+
+Additional discussion is at the top of the file and on the EmacsWiki page
linked to above.
