summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9f35833
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# Comus
+
+Comus is a kernel!
+
+## Build
+
+Run `make build` to build the kernel.
+
+Run `make clean` to clean the source tree.
+
+Run `make qemu` to build and run in qemu.
+
+Run `make qemu-kvm` to build and run in qemu with kvm enabled.
+
+Run `make qemu-gdb` to build and run in qemu with gdb debugging.
+
+Run `make gdb` to start the gdb debugger.
+
+## Docs
+
+See `docs/`
+
+## License
+
+This project is licensed under the GPLv2