docs: add execution trace to README

hirosystems · May 24, 2022 · e8bf86e · e8bf86e
1 parent 0620df4
commit e8bf86e
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -599,6 +599,14 @@ Then at the REPL prompt, debug any expression:
 
 At the debug prompt, use any of the commands described above, or use `help` to get the full help documentation.
 
+#### Execution Trace
+
+When in the console (`clarinet console`), the `::trace <expr>` command allows developers to execute an expression and print a trace of the execution, which can be very helpful for identifying problems with the contract.
+
+This trace shows all function calls, both internal calls to private functions, and contract calls to other contracts. For each call, the parameters and return value are shown in the trace. Any events that are emitted are also shown in the trace.
+
+![execution trace](docs/images/trace.png)
+
 ## Contributing
 
 We welcome contributions to Clarinet! The following sections provide information on how to contribute.

diff --git a/docs/images/trace.png b/docs/images/trace.png