From 08fad27c0edb1c55339640d8f58c85e8aa3833bc Mon Sep 17 00:00:00 2001
From: Freya Murphy <freya@freyacat.org>
Date: Thu, 27 Mar 2025 15:12:22 -0400
Subject: [PATCH] readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5e6d148
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# kern
+
+a kernel
+
+### build
+
+please install `zig`, `make`, `qemu-system-i386`, `clang-format`, `sed`, and `objcopy`
+
+run `make`
+
+built
+
+### debug
+
+run `make gdb` and `make qemu-gdb` in seperate terminals
+
+### style
+
+run `make fmt` before commiting
+
+do it
+
+### issues
+
+figure it out