Revise README formatting and add preview section
Updated formatting and added preview section to README.
| Author | Mitja Felicijan <mitja.felicijan@gmail.com> | 2026-01-16 10:16:11 +0100 |
| Committer | GitHub <noreply@github.com> | 2026-01-16 10:16:11 +0100 |
| Commit | 578a47e8fdc54da049dfbb03f384341a9ba0526f (patch) |
|
-rw-r--r-- |
README.md | 8 |
1 files changed, 6 insertions, 2 deletions
| diff --git a/README.md b/README.md | |||
| ... | |||
| 3 | This project demonstrates how to use the LLDB C++ API to build a very basic |
3 | This project demonstrates how to use the LLDB C++ API to build a very basic |
| 4 | debugger tool. |
4 | debugger tool. |
| 5 | 5 | ||
| 6 | **Requirements** |
6 | ## Requirements |
| 7 | 7 | ||
| 8 | ```sh |
8 | ```sh |
| 9 | sudo xbps-install -S lldb21-devel clang llvm llvm-devel |
9 | sudo xbps-install -S lldb21-devel clang llvm llvm-devel |
| ... | |||
| 14 | 14 | ||
| 15 | Then run the debugger with example program with `./tdbg example`. |
15 | Then run the debugger with example program with `./tdbg example`. |
| 16 | 16 | ||
| 17 | **Available commands:** |
17 | ## Available commands: |
| 18 | 18 | ||
| 19 | - `c` - Continue execution until the next breakpoint or stop |
19 | - `c` - Continue execution until the next breakpoint or stop |
| 20 | - `s` - Step into the next instruction/function |
20 | - `s` - Step into the next instruction/function |
| ... | |||
| 22 | - `bt` - Print a backtrace (call stack) of the current thread |
22 | - `bt` - Print a backtrace (call stack) of the current thread |
| 23 | - `v` - Print local variables in the current stack frame |
23 | - `v` - Print local variables in the current stack frame |
| 24 | - `q` - Kill the debugged process and exit |
24 | - `q` - Kill the debugged process and exit |
| 25 | |||
| 26 | ## Preview |
||
| 27 | |||
| 28 | https://github.com/user-attachments/assets/677f69fd-c5fe-402c-9342-3304547b29aa |
||