From f3314299e2f5d3fb321676a2fa6aaba309656653 Mon Sep 17 00:00:00 2001 From: Derek Parker Date: Mon, 21 Jul 2014 11:40:21 -0500 Subject: [PATCH] Update README --- README.md | 31 +++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 56b56535..47851d88 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,36 @@ # DBG -## What is DBG? +### What is DBG? DBG is a Go debugger, written primarily in Go. -## License +### Features + +* Attach to (trace) a running process +* Set breakpoints +* Single step through a process +* Next through a process (step over / out of subroutines) +* Never retype commands, empty line defaults to previous command + +### Usage + +* `break` +Set break point at the entry point of a function, or at a specific file/line. Example: `break foo.go:13`. + +* `step` +Single step through program. + +* `next` +Step over to next source line. + +### Upcoming features + +* Handle Gos multithreaded nature better (follow goroutine accross thread contexts) +* In-scope variable evaluation +* In-scope variable setting +* Readline integration +* Ability to launch debugging session from debugged program, with breakpoint set correctly + +### License MIT