From fb71a09ec4b282275a00b4f11cf586f9344e5fc1 Mon Sep 17 00:00:00 2001 From: Quinten Kock Date: Mon, 7 Dec 2020 23:01:59 +0100 Subject: [PATCH] Update readme.md --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index aeaeaa4..fa85cbd 100644 --- a/README.md +++ b/README.md @@ -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) \ No newline at end of file