branch: elpa/evil-lisp-state
commit 3f575dc4666542546ad63f3c943b094ab16f8819
Author: sbenner <[email protected]>
Commit: sbenner <[email protected]>
Update commentary and fix some typos
---
README.md | 24 ++++++++++++------------
evil-lisp-state.el | 19 ++++++++++++++++++-
2 files changed, 30 insertions(+), 13 deletions(-)
diff --git a/README.md b/README.md
index eb70ae7f32..0c6e236eb5 100644
--- a/README.md
+++ b/README.md
@@ -76,11 +76,11 @@ version `sp-backward-slurp-sexp` with `<tab>s`.
## Philosophy
`evil-lisp-state` goal is to replace the `normal state` in lisp buffers so
-_you should not have the need_ to switch back and forth `normal state` and
-`lisp state`. In the case you do, please fill an issue.
+_you should not have the need_ to switch back and forth between `normal state`
+and `lisp state`. In the case you do, please fill an issue.
-_Note that some mechanism will be provided in order to optional have
-`insert state` to go back to `lisp state` when pressing `ESC`. Stay tuned._
+_Note that some mechanism will be provided in order to have `insert state`
+to optionally go back to `lisp state` when pressing `ESC`. Stay tuned._
To achieve this goal, this mode tries to keep the useful commands from the
`normal state` and add new commands (often with `shift` modifier) for
@@ -143,15 +143,15 @@ Key Binding | Function
`0` | sp-beginning-of-sexp
`A` | sp-absorb-sexp
`b` | sp-forward-barf-sexp
-`<tab>b` | sp-backward-barf-sexp
+`<tab> b` | sp-backward-barf-sexp
`C` | sp-convolute-sexp
`Dd` | sp-kill-hybrid-sexp
`Dx` | sp-kill-sexp
-`<tab>Dx` | sp-backward-kill-sexp
+`<tab> Dx` | sp-backward-kill-sexp
`Ds` | sp-kill-symbol
-`<tab>Ds` | sp-backward-kill-symbol
+`<tab> Ds` | sp-backward-kill-symbol
`Dw` | sp-kill-word
-`<tab>Dw` | sp-backward-kill-word
+`<tab> Dw` | sp-backward-kill-word
`E$` | evil-lisp-state-eval-sexp-end-of-line
`Ee` | eval-last-sexp
`Ef` | eval-defun
@@ -165,14 +165,14 @@ Key Binding | Function
`M` | sp-join-sexp (think about `merge-sexp`)
`R` | sp-raise-sexp
`s` | sp-forward-slurp-sexp
-`<tab>s` | sp-backward-slurp-sexp
+`<tab> s` | sp-backward-slurp-sexp
`S` | sp-splice-sexp-killing-forward
-`<tab>S` | sp-splice-sexp-killing-backward
+`<tab> S` | sp-splice-sexp-killing-backward
`w` | wrap sexp
`W` | unwrap sexp
-`<tab>W` | sp-backward-unwrap-sexp
+`<tab> W` | sp-backward-unwrap-sexp
`Y` | sp-copy-sexp
-`<tab>y` | sp-backward-copy-sexp
+`<tab> y` | sp-backward-copy-sexp
`backspace` | sp-backward-delete-char
`S-backspace` | sp-delete-char
`RET` | sp-newline (stay in `lisp state` see `o` to switch to `insert
state`)
diff --git a/evil-lisp-state.el b/evil-lisp-state.el
index 2d410576fb..c8ceeba2c5 100644
--- a/evil-lisp-state.el
+++ b/evil-lisp-state.el
@@ -29,7 +29,22 @@
;; Adds a new Evil state called --LISP-- (<L>) with mnemonics key bindings
;; to navigate Lisp code and edit the sexp tree.
-;; Simple to grasp navigation model:
+;; Philosophy
+;; ----------
+
+;; `evil-lisp-state` goal is to replace the `normal state` in lisp buffers so
+;; _you should not have the need_ to switch back and forth between `normal
state`
+;; and `lisp state`. In the case you do, please fill an issue.
+
+;; _Note that some mechanism will be provided in order to have `insert state`
+;; to optionally go back to `lisp state` when pressing `ESC`. Stay tuned._
+
+;; To achieve this goal, this mode tries to keep the useful commands from the
+;; `normal state` and add new commands (often with `shift` modifier) for
+;; manipulating the data structure.
+
+;; Intuitive navigation model
+;; --------------------------
;; `hjkl` behaves like in the default `normal state`.
@@ -42,6 +57,8 @@
;; - `K` go to previous one level up
;; Example Configuration:
+;; ----------------------
+
;; override the `L` key bindings of evil `motion state`:
;; (require 'evil-lisp-state)
