Skip to content

Commit

Permalink
Add section on recommended bindings
Browse files Browse the repository at this point in the history
  • Loading branch information
GuiltyDolphin committed Jul 13, 2018
1 parent 824b58e commit 63f3927
Showing 1 changed file with 21 additions and 4 deletions.
25 changes: 21 additions & 4 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,28 @@ above becomes:

** Viewing keymaps

Run ~M-x emaps-describe-keymap-bindings~ (recommended binding ~C-h K~) to
display the bindings for a given keymap (see below), ~emaps-describe-keymap~
can be used to view keymaps as variables (but with characters displayed instead
of integers, where possible).
Run ~M-x emaps-describe-keymap-bindings~ to display the
bindings for a given keymap (see below),
~emaps-describe-keymap~ can be used to view keymaps as
variables (but with characters displayed instead of integers,
where possible).

#+CAPTION: Display after running ~emaps-describe-keymap-bindings~ with ~magit-status-mode-map~.
#+NAME: fig:emaps-describe-keymap-bindings-magit-status-mode-map
[[./images/emaps-describe-keymap-bindings.png]]

** Recommended Bindings

I recommend the following bindings with Emaps (though I
encourage you to experiment and find what works best for you):

| Key | Command |
|---------+----------------------------------|
| ~C-h K~ | ~emaps-describe-keymap-bindings~ |

Which you can set with the following snippet:

#+BEGIN_SRC emacs-lisp
(emaps-define-key global-map
(kbd "C-h K") 'emaps-describe-keymap-bindings)
#+END_SRC

0 comments on commit 63f3927

Please sign in to comment.