1 files changed, 25 insertions, 0 deletions
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