From feb222c2623d5e3e75ecd8adc2aa294b44d5c710 Mon Sep 17 00:00:00 2001
From: Rekai Musuka <rekai@musuka.dev>
Date: Sun, 11 Dec 2022 04:04:57 -0400
Subject: [PATCH] chore: add README.md

---
 README.md | 9 +++++++++
 build.zig | 2 +-
 2 files changed, 10 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c7abf4a
--- /dev/null
+++ b/README.md
@@ -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.
diff --git a/build.zig b/build.zig
index 97c6a68..c51a434 100644
--- a/build.zig
+++ b/build.zig
@@ -11,7 +11,7 @@ pub fn build(b: *std.build.Builder) void {
     // between Debug, ReleaseSafe, ReleaseFast, and ReleaseSmall.
     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
     exe.addPackagePath("network", "lib/zig-network/network.zig");