[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/rainbow-delimiters 3482ea5ced 002/188: Update README to li
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/rainbow-delimiters 3482ea5ced 002/188: Update README to link to the appropriate locations at EmacsWiki. |
Date: |
Sat, 1 Jan 2022 00:58:47 -0500 (EST) |
branch: elpa/rainbow-delimiters
commit 3482ea5ced6f0fe97958a107bbc72ccbbebb75c7
Author: Jeremy L. Rayman <jeremy.rayman@gmail.com>
Commit: Jeremy L. Rayman <jeremy.rayman@gmail.com>
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.
- [nongnu] elpa/rainbow-delimiters 0823d0c67f 176/188: Release version 2.1.1, (continued)
- [nongnu] elpa/rainbow-delimiters 0823d0c67f 176/188: Release version 2.1.1, ELPA Syncer, 2022/01/01
- [nongnu] elpa/rainbow-delimiters d576e6694a 188/188: Add Emacs 27.2 to CI, ELPA Syncer, 2022/01/01
- [nongnu] elpa/rainbow-delimiters 8911d984e6 004/188: Use markdown syntax in the README file., ELPA Syncer, 2022/01/01
- [nongnu] elpa/rainbow-delimiters 8dded7ba49 010/188: Bugfix: Removing text properties using re-search-forward can now go to point-max instead of (1- (point-max)), apparently thanks to a change in Emacs CVS., ELPA Syncer, 2022/01/01
- [nongnu] elpa/rainbow-delimiters bb38452706 155/188: Remove the Emacs Lisp specific escaping test., ELPA Syncer, 2022/01/01
- [nongnu] elpa/rainbow-delimiters c37b61c4b5 163/188: Release version 2.0.1., ELPA Syncer, 2022/01/01
- [nongnu] elpa/rainbow-delimiters 3d1e204f04 169/188: Allow the user to customize the way faces are picked., ELPA Syncer, 2022/01/01
- [nongnu] elpa/rainbow-delimiters 7919681b0d 187/188: Use keyword arguments in define-minor-mode, ELPA Syncer, 2022/01/01
- [nongnu] elpa/rainbow-delimiters eb7b957adc 001/188: Initial commit., ELPA Syncer, 2022/01/01
- [nongnu] elpa/rainbow-delimiters 55d098bc39 013/188: Add changelog entry noting addition of global-rainbow-delimiters-mode., ELPA Syncer, 2022/01/01
- [nongnu] elpa/rainbow-delimiters 3482ea5ced 002/188: Update README to link to the appropriate locations at EmacsWiki.,
ELPA Syncer <=
- [nongnu] elpa/rainbow-delimiters 25ad3c3def 016/188: Update README.markdown; include instructions re: global-rainbow-delimiters-mode., ELPA Syncer, 2022/01/01
- [nongnu] elpa/rainbow-delimiters 779b40f39d 021/188: Update README.markdown; include instructions re: global-rainbow-delimiters-mode., ELPA Syncer, 2022/01/01
- [nongnu] elpa/rainbow-delimiters a44624fa05 018/188: Update README.markdown; include instructions re: global-rainbow-delimiters-mode., ELPA Syncer, 2022/01/01
- [nongnu] elpa/rainbow-delimiters 56faa7bd86 019/188: Update README.markdown; include instructions re: global-rainbow-delimiters-mode., ELPA Syncer, 2022/01/01
- [nongnu] elpa/rainbow-delimiters 1dc8ea6fdf 027/188: Change top-line description for marmalade-repo.org., ELPA Syncer, 2022/01/01
- [nongnu] elpa/rainbow-delimiters 0444666196 025/188: Note Bugfix of syntax-table problem in the 1.4 release notes., ELPA Syncer, 2022/01/01
- [nongnu] elpa/rainbow-delimiters 8a8ee4e4e1 039/188: Merge branch 'master' of github.com:jlr/rainbow-delimiters, ELPA Syncer, 2022/01/01
- [nongnu] elpa/rainbow-delimiters 493b514ae7 037/188: Color scheme for light backgrounds., ELPA Syncer, 2022/01/01
- [nongnu] elpa/rainbow-delimiters d44ed19ade 030/188: Note that rainbow-delimiters-depth-1-face only gets applied to outermost delimiter pair. (Stylistically this is nice because it makes the outermost pair distinct.), ELPA Syncer, 2022/01/01
- [nongnu] elpa/rainbow-delimiters 54855dcf52 062/188: Revert a part of 3dfd3fa9b that shouldn't be changed in the first place., ELPA Syncer, 2022/01/01