aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMatt Borgerson <mborgerson@gmail.com>2016-04-20 01:08:26 -0700
committerMatt Borgerson <mborgerson@gmail.com>2016-04-20 01:30:35 -0700
commitbceb2a5ae67e661b7ef00c07b14db425ca14453d (patch)
tree6f79ff4903ec0213e676e4c2f7b97ce24d667d91 /README.md
parente677c14dc715da62ad5749a4ab740803e58b0a7f (diff)
downloadgdbstub-bceb2a5ae67e661b7ef00c07b14db425ca14453d.tar.gz
Add GDB stub code
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..59a6c01
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+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.
+
+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).
+
+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
+`gdbstub_sys.h` and `gdbstub_sys.c` to fit your platform's needs accordingly.
+
+License
+-------
+Licensed under GPL v2. See `LICENSE.txt` for full license.
+
+Matt Borgerson, 2016