diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 23 |
1 files changed, 16 insertions, 7 deletions
@@ -5,38 +5,47 @@ much more contextual information. SCREENSHOT -## Source code +## Features + +### Source code Helpful will try really hard to show the source code. It shows the source code for interactively defined functions (unlike the built-in Help) and falls back to the raw sexp if no source is available. -## View Callers +### View Callers Helpful will show you where a function is being called! -## Pretty Docstrings +### Pretty Docstrings Helpful renders docstrings with full cross-references, hiding superfluous punctuation. -## Symbol Properties +### Symbol Properties Helpful will show you the properties that have been applied to the current symbol. This provides visibility of features like edebug or byte-code optimisation. -## Describe Commands +### Describe Commands Helpful provides a separate `helpful-command` function, for when you just want to view interactive functions. -## View Keymaps +### View Keymaps Helpful displays any keybindings that apply to interactive functions. -## Integrated Tooling +### Integrated Tooling You can trace, debug or disassemble functions from inside Helpful. This is discoverable and doesn't require memorisation of commands. + +## Inspirations + +This project has been heavily influenced by: + +* [help+.el](https://www.emacswiki.org/emacs/help+.el), help-fns+.el, help-mode+.el +* [Dave Williams' demo of Lucid's Energize](https://www.youtube.com/watch?v=pQQTScuApWk) |