commit 3154f8a405f94ffd50f646738dc0737ec2c9a29d
parent 173abf8b39dd62a161e940c904ddb7c7cea552f9
Author: Wilfred Hughes <me@wilfred.me.uk>
Date: Mon, 5 Jun 2017 22:27:55 +0100
Screenshots
Diffstat:
7 files changed, 12 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
@@ -3,27 +3,35 @@
Helpful is an alternative to the built-in Emacs help that provides
much more contextual information.
-SCREENSHOT
+
## 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
+
+
Helpful will show you where a function is being called!
### Pretty Docstrings
+
+
Helpful renders docstrings with full cross-references, hiding
superfluous punctuation.
### 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.
@@ -35,11 +43,13 @@ just want to view interactive functions.
### View Keymaps
+
+
Helpful displays any keybindings that apply to interactive functions.
### Integrated Tooling
-You can trace, debug or disassemble functions from inside
+You can trace, debug (coming soon) or disassemble functions from inside
Helpful. This is discoverable and doesn't require memorisation of
commands.
diff --git a/screenshots/helpful.png b/screenshots/helpful.png
Binary files differ.
diff --git a/screenshots/helpful_bindings.png b/screenshots/helpful_bindings.png
Binary files differ.
diff --git a/screenshots/helpful_docs.png b/screenshots/helpful_docs.png
Binary files differ.
diff --git a/screenshots/helpful_props.png b/screenshots/helpful_props.png
Binary files differ.
diff --git a/screenshots/helpful_refs.png b/screenshots/helpful_refs.png
Binary files differ.
diff --git a/screenshots/helpful_source.png b/screenshots/helpful_source.png
Binary files differ.
