chore: add README.md

This commit is contained in:
Rekai Nyangadzayi Musuka 2022-12-11 04:04:57 -04:00
parent 3ba7f22c07
commit feb222c262
2 changed files with 10 additions and 1 deletions

9
README.md Normal file
View File

@ -0,0 +1,9 @@
# ZBA-GDBSTUB
This is a gdbstub server for paoda/zba, because I don't want to import a C library and i _love_ reinventing the wheel I guess.
## Scope
This is tailor made for targeting the GBA. Anything that isn't necessary for stepping through ARMv4T code isn't included. This means lots of hardcoded values and assumptions that would be really awful for any halfway decent gdbstub implementation.
This project will have succeeded as soon as I use it to determine why Rhythm Heaven is stuck in an infinite loop.

View File

@ -11,7 +11,7 @@ pub fn build(b: *std.build.Builder) void {
// between Debug, ReleaseSafe, ReleaseFast, and ReleaseSmall. // between Debug, ReleaseSafe, ReleaseFast, and ReleaseSmall.
const mode = b.standardReleaseOptions(); const mode = b.standardReleaseOptions();
const exe = b.addExecutable("gdbstub", "src/main.zig"); const exe = b.addExecutable("zba-gdbstub", "src/main.zig");
// https://github.com/MasterQ32/zig-network // https://github.com/MasterQ32/zig-network
exe.addPackagePath("network", "lib/zig-network/network.zig"); exe.addPackagePath("network", "lib/zig-network/network.zig");