diff options
| author | Wilfred Hughes <me@wilfred.me.uk> | 2017-12-06 22:29:57 +0000 |
|---|---|---|
| committer | Wilfred Hughes <me@wilfred.me.uk> | 2017-12-06 22:29:57 +0000 |
| commit | 3b2141975f9f54f7433b9ea9947df0849864a26a (patch) | |
| tree | e07c7bb4acbb64b818fb2a619b3c612fbe772671 /README.md | |
| parent | 2d68df222e432eb9f1f3ccdf558cbd2542254cb8 (diff) | |
Document usage
Show how to set up keybindings, and stress the difference between
describe-function, helpful-function, and helpful-callable.
Closes #39
Closes #60
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 32 |
1 files changed, 32 insertions, 0 deletions
@@ -5,6 +5,38 @@ much more contextual information.  +## Usage + +Install from MELPA, then call one of the following commands: + +* `helpful-callable` +* `helpful-function` +* `helpful-macro` +* `helpful-command` +* `helpful-key` +* `helpful-variable` +* `helpful-at-point` + +If you want to replace the default Emacs help keybindings, you can do +so: + +``` emacs-lisp +;; Note that the built-in `describe-function' includes both functions +;; and macros. `helpful-function' is functions only, so we provide +;; `helpful-callable' as a drop-in replacement. +(global-set-key (kbd "C-h f") #'helpful-callable) + +(global-set-key (kbd "C-h v") #'helpful-variable) +(global-set-key (kbd "C-h k") #'helpful-key) +``` + +I also recommend you configure `helpful-at-point` to a convenient +keybinding: + +``` emacs-lisp +(global-set-key (kbd "C-c C-.") #'helpful-at-point) +``` + ## Features ### Source code |
