diff --git a/README.md b/README.md index 22fcb493..932185ab 100644 --- a/README.md +++ b/README.md @@ -143,7 +143,6 @@ Keybinding | Description C-- | Decrease font size (`text-scale-decrease`). M-C-l | Switch back and forth between the 2 top buffers (from XEmacs). C-c C-SPC | Toggle highlight of the symbol under the cursor (by default, up to 8 different symbols using different colors). -C-o | Display a transient with bindings for a `casual` user of `org-agenda`, `bookmark`, `calc`, `calendar`, `dired`, `ibuffer`, `info`, `isearch`, `rebuilder`, `symbol-overlay` or a Casual EditKit menu. Editing: @@ -209,6 +208,29 @@ Keybinding | Description You can change the modifier key (default: M) by customizing `exordium-highlight-symbol-map-modifier`. +## Help extensions +Exordium provides a few help extensions that enhance default Emacs +configuration presenting user with more information. All of them are enabled by +setting `exordium-help-extensions` to t. Noteably, the following are turned on: + +- [which-key](https://github.com/justbur/emacs-which-key) - display available + keybindings after a short while (for example type C-x and wait a + second, +- [casual](https://github.com/kickingvegas/casual) - a collection of + opinionated keyboard-driven user interfaces for various built-in Emacs modes, +- [helpful](https://github.com/Wilfred/helpful) - an alternative to the + built-in Emacs help that provides much more contextual information. + +Keybinding | Description +------------------- |---------------------------------------------------------- +C-o | Display a transient with bindings for a `casual` user of `org-agenda`, `bookmark`, `calc`, `calendar`, `dired`, `ibuffer`, `info`, `isearch`, `rebuilder`, `symbol-overlay` or a Casual EditKit menu. +C-h f | Show `helpful` buffer for function, macro, or a special form (`helpful-callable`). +C-h F | Show `helpful` buffer for function (`helpful-function`). +C-h v | Show `helpful` buffer for variable (`helpful-variable`). +C-h C | Show `helpful` buffer for interactive command (`helpful-command`). +C-c C-d | Show `helpful` buffer for thing at point, when in `emacs-lisp-mode` (`helpful-thing-at-point`). +C-j | Show `helpful` buffer for currently selected candidate, when completing read for `helpful` commands. + ## Projectile [Projectile](https://github.com/bbatsov/projectile) adds the notion of