summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBozhidar Batsov <bozhidar@batsov.com>2016-04-11 14:03:22 -0700
committerBozhidar Batsov <bozhidar@batsov.com>2016-04-11 14:03:22 -0700
commit3cee452d076c2651977bf3a392b8d2ea9d36ac9c (patch)
tree37df42897f68a439c002610ce922938622cb8e56 /doc
parent978ef1ff2273547fe6edda27a2f2b4371c70f0d7 (diff)
Add an animated gif showing the debugger in action
Diffstat (limited to 'doc')
-rw-r--r--doc/debugging.md9
-rw-r--r--doc/images/cider_debugger.gifbin0 -> 265390 bytes
2 files changed, 8 insertions, 1 deletions
diff --git a/doc/debugging.md b/doc/debugging.md
index ed4f2fb3..c1870fc4 100644
--- a/doc/debugging.md
+++ b/doc/debugging.md
@@ -1,3 +1,8 @@
+CIDER ships with a powerful interactive Clojure debugger inspired by Emacs's own
+[Edebug][]. You're going to love it!
+
+![CIDER Debugger](images/cider_debugger.gif)
+
### Debugging
The debugger can be invoked in several ways, the simplest one is to type
@@ -35,7 +40,7 @@ instrumented as well, but they will not be listed by this command.
#### Keys
`cider-debug` tries to be consistent with
-[Edebug](http://www.gnu.org/software/emacs/manual/html_node/elisp/Edebug.html). So
+[Edebug][]. So
it makes available the following bindings while stepping through code.
Keyboard shortcut | Description
@@ -93,3 +98,5 @@ A few example of forms that don't have interesting return values (and so are not
- Similarly, in a form like `(map inc (range 10))`, the symbol `inc` points to a
function in `clojure.core`. That's also irrelevant (unless it's being shadowed
by a local, but the debugger can identify that).
+
+[Edebug]: http://www.gnu.org/software/emacs/manual/html_node/elisp/Edebug.html
diff --git a/doc/images/cider_debugger.gif b/doc/images/cider_debugger.gif
new file mode 100644
index 00000000..a1b3a34b
--- /dev/null
+++ b/doc/images/cider_debugger.gif
Binary files differ