aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTslil Clingman <tslil.clingman@gmail.com>2018-07-07 23:50:39 +0200
committerTslil Clingman <tslil.clingman@gmail.com>2018-07-07 23:50:39 +0200
commitefa4b2efff0866f9b3ab45e204f283d6399e9733 (patch)
treef37f06ea766d2da8da685251a80aac3750678754 /README.md
parent94c3cc8829dbe11550ba702a33b947dc9f68b28f (diff)
Complete rewrite of derivation procedure
siege-mode now tokenizes the input, reverses it, and then applies transformations. This way nested delimiters are automatically reversed, and atomic blocks (like latex {equation}) are not affected. Also, GIF.
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 14 insertions, 15 deletions
diff --git a/README.md b/README.md
index 24e8534..ad4c1d5 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,26 @@
# siege-mode
-An emacs minor mode to surround the region with smart delimiters
-interactively.
+An emacs minor mode to surround the region with smart delimiters interactively.
## Lay siege to the region from all sides!
### (with the power of regular expressions)
-When the region is active, all input is redirected to the minibuffer
-and treated as a delimiter for the region. By default the input is
-used as the left delimiter from which the right one is derived using
-`siege-left-to-right-regexs`. This may be reversed by default
-(`siege-default-left`) or during usage via "C-c r" in the minibuffer.
-If regexes are not desired they may be disabled via "C-c a" in the
-minibuffer or by default (`siege-default-apply-regexs`).
+When the region is active, all input is redirected to the minibuffer and treated
+as a delimiter for the region. The input is used as the left delimiter from
+which the right one is derived using `siege-transform-regexs` applied to tokens
+generated by `siege-boundary-list` and `siege-block-*`. If such derivations are
+not desired they may be disabled via "C-c a" in the minibuffer or by default
+(`siege-default-derive`).
-All changes are dynamically displayed in the buffer (see
-`siege-preview-face`) and may be committed by "SPC" or "Ret" in the
-minibuffer.
+All changes are dynamically displayed in the buffer (see `siege-preview-face`)
+and may be committed by "SPC" or "Ret" in the minibuffer.
-The defaults support the obvious pairings, as well as `begin <--> end`
-and `left <--> right` of LaTeX fame.
+By default siege-mode understands the usual delimeter pairs, as well as latex
+LaTeX begin/end pairs and left/right pairs. Moreover, for ease of use it will
+pair both `_{` and `^{` with `}` by default.
## Fancy GIF demo
-Accepting donations.
+
+![siege-mode.gif](siege-mode.gif)
## License