diff --git a/README.md b/README.md index fbf1456..c0ec696 100644 --- a/README.md +++ b/README.md @@ -1 +1,7 @@ -# debugger-from-scratch \ No newline at end of file +# debugger-from-scratch + +This is a very simple debugger that shows how ptrace can be used to set breakpoints and generate stack traces in a target process. You can choose where to breakpoint the target process, and single step or continue to the next breakpoint (or target exit). + +Big caveat: it assumes there is only one file in the target! + +I fully expect this only to work on Linux.