Engage!

1 files changed, 24 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3f73f2c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# Toy Debugger
+
+This project demonstrates how to use the LLDB C++ API to build a very basic
+debugger tool.
+
+**Requirements**
+
+```sh
+sudo xbps-install -S lldb21-devel clang llvm llvm-devel
+```
+
+After you clone the repository build the debugger and a sample program with
+`make`.
+
+Then run the debugger with example program with `./tdbg example`.
+
+**Available commands:**
+
+- `c` - Continue execution until the next breakpoint or stop
+- `s` - Step into the next instruction/function
+- `n` - Step over the next instruction/function
+- `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