Update readme.md

This commit is contained in:
Quinten Kock 2020-12-07 23:01:59 +01:00
parent 9c51d9da98
commit fb71a09ec4
1 changed files with 11 additions and 1 deletions

View File

@ -12,8 +12,16 @@ KornOS is a microkernel-based operating system targeting ARMv6+ and 80386+.
- [x] x86-64 GDT parsing
- [ ] x86-32 GDT parsing
## Trying it out
## Getting started
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.
Note: to clone the repo and ensure all bundled dependencies are pulled in, run `git clone --recurse-submodules https://git.dehosting.club/quintenk/kornos.git`.
Quick-start:
```
git clone --recurse-submodules https://git.dehosting.club/quintenk/kornos.git
cd kornos
make run
```
### Dependencies
- `cc` (for host utilities)
- `zig` (for `zig cc` cross-compiler)
@ -21,3 +29,5 @@ KornOS has an extensive Make-based build system. Making sure all dependencies ar
- `echfs-utils` (Bundled, requires libuuid-devel)
- `limine` (Bundled)
- `parted`
- `qemu-system-x86_64`
- `gdb` (if you want to debug the kernel)