From 9c51d9da985cf0a8347de77c5f9eafbef5da122d Mon Sep 17 00:00:00 2001
From: Quinten Kock <quintenkock@gmail.com>
Date: Mon, 7 Dec 2020 22:56:37 +0100
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..aeaeaa4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# KornOS
+KornOS is a microkernel-based operating system targeting ARMv6+ and 80386+. 
+
+## Progress
+### Booting
+- [x] Boot using stivale2 on x86. (Limine is 686+?)
+- [ ] Boot using multiboot(2) on x86.
+- [ ] Boot using BOOTBOOT on x86-64
+- [ ] Boot on Raspberry Pi 0-4
+### Kernel
+- [x] Kernel printing
+- [x] x86-64 GDT parsing
+- [ ] x86-32 GDT parsing
+
+## Trying it out
+KornOS has an extensive Make-based build system. Making sure all dependencies are present and then `make run` should be sufficient to boot into KornOS for x86-64.
+### Dependencies
+- `cc` (for host utilities)
+- `zig` (for `zig cc` cross-compiler)
+- `nasm`
+- `echfs-utils` (Bundled, requires libuuid-devel)
+- `limine` (Bundled)
+- `parted`