From 07a0b90d369ec054b78f055cdf8e68b1463b6f82 Mon Sep 17 00:00:00 2001
From: Simon Gellis <simongellis@gmail.com>
Date: Sun, 13 Oct 2024 12:39:13 -0400
Subject: [PATCH] Add README

---
 README.md | 5 +++++
 1 file changed, 5 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..11749ac
--- /dev/null
+++ b/README.md
@@ -0,0 +1,5 @@
+# V810 Standalone GDB Server
+
+This is a GDB/LLDB-compatible remote serial protocol server wrapping the [shrooms-vb](https://git.virtual-boy.com/PVB/pvbemu) emulation core. You can use it with [a v810-compatible version of lldb](https://github.com/SupernaviX/v810-llvm/releases) to debug your Virtual Boy games in your favorite IDE.
+
+This program has no input or output, so it's more of a POC than a usable tool. Future plans are to add the server to a full emulator.