diff --git a/kernel-rs/README.md b/kernel-rs/README.md index b6eb0cce..ef0dd502 100644 --- a/kernel-rs/README.md +++ b/kernel-rs/README.md @@ -1,8 +1,8 @@ -based on [Writing an OS in rust](https://os.phil-opp.com/) +Kernel from scratch (KFS) series of projects at Ecole 42 ! # compiling -## dependencies +### dependencies - `nasm` compiles the bootcode - `ld` links the bootcode @@ -12,7 +12,7 @@ based on [Writing an OS in rust](https://os.phil-opp.com/) on archlinux `pacman -S make grub2 xorriso mtools binutils gcc qemu` -## rust setup +### rust setup ``` pacman -S rustup @@ -21,7 +21,7 @@ rustup component add rust-src cargo install xargo ``` -## docker +### docker a standard development environment can be invoked: ``` @@ -33,3 +33,8 @@ clone the repo and `make iso` # running `make run` in your host operating system to launch qemu gtk window + +# References + + - [Rust page on OSDev wiki](https://wiki.osdev.org/Rust) + - [Writing an OS in rust](https://os.phil-opp.com/) extremely helpful to get things going on x86 and nightly rust