summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md
index 7b8fcfe..4ace121 100644
--- a/README.md
+++ b/README.md
@@ -23,6 +23,9 @@ ztrace probe --dry-run --usdt provider:name -- ./prog # ... with BPF, for
ztrace dump fib.ztrace
```
+The separate [native debugger GUI](gui/README.md) uses both libraries for live
+breakpoints, stepping, registers, disassembly, stack/telescope and recorded history.
+
## The pieces
| Where | What |
@@ -38,6 +41,7 @@ ztrace dump fib.ztrace
| `llvm/pass.cpp`, `src/instr/` | compiler instrumentation: the LLVM pass, the runtime it calls, the type descriptions |
| `src/trace/perf.zig`, `bpf.zig`, `usdt.zig` | the kernel's view: perf events for any user, BPF programs for root, the static probes of `<sys/sdt.h>` |
| `anim/` | canim, a package of its own (it needs sketchbook and pardes; ztrace does not): the animation library and its scenes |
+| `gui/` | the standalone native debugger application; uses ztrace and canim |
| `design/` | the visual system the animations follow, with mock frames |
| `src/cli/` | the `ztrace` command, a file a subcommand |
| `targets/` | programs to trace |