Add README.md

This commit is contained in:
Quinten Kock 2020-12-07 22:56:37 +01:00
parent b0e433fca2
commit 9c51d9da98
1 changed files with 23 additions and 0 deletions

23
README.md Normal file
View File

@ -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`