summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMitja Felicijan <mitja.felicijan@gmail.com>2026-01-16 10:16:11 +0100
committerGitHub <noreply@github.com>2026-01-16 10:16:11 +0100
commit578a47e8fdc54da049dfbb03f384341a9ba0526f (patch)
tree60fdcd7c905d3b5061688278ddc2e55080dac6a2 /README.md
parentc79ff421298851d2b7bffa52db500e0ab9f5f12d (diff)
downloadtoy-debugger-578a47e8fdc54da049dfbb03f384341a9ba0526f.tar.gz
Revise README formatting and add preview section
Updated formatting and added preview section to README.
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/README.md b/README.md
index 3f73f2c..da8076b 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
This project demonstrates how to use the LLDB C++ API to build a very basic
debugger tool.
-**Requirements**
+## Requirements
```sh
sudo xbps-install -S lldb21-devel clang llvm llvm-devel
@@ -14,7 +14,7 @@ After you clone the repository build the debugger and a sample program with
Then run the debugger with example program with `./tdbg example`.
-**Available commands:**
+## Available commands:
- `c` - Continue execution until the next breakpoint or stop
- `s` - Step into the next instruction/function
@@ -22,3 +22,7 @@ Then run the debugger with example program with `./tdbg example`.
- `bt` - Print a backtrace (call stack) of the current thread
- `v` - Print local variables in the current stack frame
- `q` - Kill the debugged process and exit
+
+## Preview
+
+https://github.com/user-attachments/assets/677f69fd-c5fe-402c-9342-3304547b29aa