From 30ae9d188d4f35e12b90a0251ddbf4baf4a9f623 Mon Sep 17 00:00:00 2001 From: Matt Borgerson Date: Tue, 17 Dec 2019 12:09:29 -0700 Subject: Update README --- README.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 59a6c01..0ac0b59 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,27 @@ gdbstub ======= -This is a simple gdb stub that can be easily dropped in to your project. It -has no external dependencies and requires just standard tools to build. +This is a simple gdb stub that can be easily dropped in to your project. It has +no library dependencies (such as libc) and requires just standard tools to +build. Protocol -------- -Communication between the stub and the debugger takes place via the [gdb Remote Serial Protocol](https://sourceware.org/gdb/onlinedocs/gdb/Remote-Protocol.html). +Communication between the stub and the debugger takes place via the [gdb +Remote Serial Protocol](https://sourceware.org/gdb/onlinedocs/gdb/Remote-Protocol.html). Porting ------- -This was developed for x86 systems but it's fairly modular. So, with a little -effort, it should work on other platforms. You will need to modify +This was developed for x86 systems, but it's fairly modular. With a little +effort, it should be easily ported to other platforms. You will need to modify `gdbstub_sys.h` and `gdbstub_sys.c` to fit your platform's needs accordingly. +Building +-------- +Running `make` produces a simple binary that will hook the current IDT and +break. + License ------- Licensed under GPL v2. See `LICENSE.txt` for full license. -Matt Borgerson, 2016 +Matt Borgerson, 2016-2019 -- cgit v1.2.3