[elpa] externals/easy-escape c35994a 08/27: Add README

[ELPA Syncer]

branch: externals/easy-escape
commit c35994a1c9ae874cbc838e3cd36763bb49c6ae4d
Author: Clément Pit--Claudel <clement.pitclaudel@live.com>
Commit: Clément Pit--Claudel <clement.pitclaudel@live.com>

    Add README
---
 README.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 61 insertions(+)

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..50d1b6a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,61 @@
+# `easy-escape`
+
+![Easy-escape: before and after](img/easy-escape.png)
+
+`easy-escape-minor-mode` composes double backslashes (escape characters) into 
single backslashes, and highlights them to improve readability. For example, 
`easy-escape` displays `"\\(?:\\_<\\\\newcommand\\_>\\s-*\\)?"` as 
`"\(?:\_<\\newcommand\_>\s-*\)?"`. The underlying buffer text is not modified.
+
+The default is to use a single \ character instead of two, but the character 
used and its color can be customized using `easy-escape-face` and 
`easy-escape-character`.
+
+## Screenshots
+
+### Using a custom color
+
+![Easy-escape: before and after](img/easy-escape-other-color.png)
+
+### Using a custom character
+
+![Easy-escape: before and after](img/easy-escape-other-character.png)
+
+## Setup
+
+### MELPA (preferred)
+
+This will be valid if the package gets accepted on MELPA:
+
+1. Setup [MELPA](http://melpa.org/#/getting-started) if you haven't yet
+
+    In your `.emacs`, add these three lines:
+
+    ```elisp
+    (require 'package)
+    (add-to-list 'package-archives '("melpa" . "http://melpa.org/packages/";) t)
+    (package-initialize)
+    ```
+
+2. Install the package: `M-x package-install RET easy-mode RET`
+
+### Alternative setup
+
+1. Download [this 
file](https://raw.githubusercontent.com/cpitclaudel/easy-escape/master/easy-escape.el)
+2. Add this to your .emacs:
+
+    ```elisp
+    (load-file "PATH-TO-THE-FILE-YOU-JUST-DOWNLOADED")
+    ```
+
+## Fine-tuning
+
+If you find the distinction between the fontified double-slash and the
+single slash too subtle, try the following:
+
+* Adjust the foreground of `easy-escape-face`:
+
+    ```elisp
+    (set-face-attribute 'easy-escape-face nil :foreground "red")
+    ```
+
+* Set `easy-escape-character` to a different character:
+
+    ```elisp
+    (setq easy-escape-character ?╲)
+    ```