Update README.md

lizrice · Nov 5, 2017 · 6f4b62f · 6f4b62f
1 parent 3caa07f
commit 6f4b62f
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,7 @@
-# debugger-from-scratch
+# 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.