branch: externals/cm-mode
commit 255322940f3c03606997f73b2ac55ae4e01722c1
Author: Joost Kremers <[email protected]>
Commit: Joost Kremers <[email protected]>
Add some CriticMarkup to the README.
---
README.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 94bc1bac1a..33aa9591c0 100644
--- a/README.md
+++ b/README.md
@@ -11,9 +11,9 @@ CriticMarkup defines the following patterns for marking
changes to a text:
- Comment {>> <<}
- Highlight {{ }}{>> <<}
-Note: additions are called insertions here, because it allows us to use
mnemonic key bindings.
+Note: additions are called insertions here, because it allows us to use
mnemonic key bindings. {>>That's because 'a' is reserved for accepting a
change. Perhaps you should mention that?<<}
-Activating `cm-mode` provides key bindings to insert the patterns above and
thus mark one's changes to the text. The provided key bindings are:
+Activating `cm-mode` provides key{--s--} {++bindings++} to insert the
{~~patterns~>markup~~} above and thus mark one's changes to the text. The
provided key bindings are:
- `C-c * i`: insert text
- `C-c * d`: delete text
@@ -21,7 +21,7 @@ Activating `cm-mode` provides key bindings to insert the
patterns above and thus
- `C-c * c`: insert a comment
- `C-c * h`: highlight text and insert a comment
-The commands to delete, substitute and highlight text all operate on the
region. The commands for inserting and substituting text and for inserting a
comment (which includes the command to highlight text) all put the cursor at
the correct position, so you can start typing right away.
+The commands to delete, substitute and highlight text all operate on the
region. The commands for inserting and substituting text and for inserting a
comment {{(which includes the command to highlight text)}}{>>really!<<} all put
the cursor at the correct position, so you can start typing right away.
`cm-mode` also adds the markup patterns defined by CriticMarkup to
`font-lock-keywords` and provides customisable faces to highlight them. The
customisation group is called `criticmarkup`.
