1 files changed, 19 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..2cc5334
--- /dev/null
+++ b/README
@@ -0,0 +1,19 @@
+building requirments
+====================
+
+- bsd-compatible make 
+- a [riscv toolchain](https://github.com/riscv/riscv-gnu-toolchain)
+- qemu built for riscv64 with some kind of mmu support
+- [device tree compiler](https://github.com/dgibson/dtc)
+
+building
+========
+
+compile and test the kernel 
+
+```
+make clean sys
+make debug
+```
+
+