From 50fcf59a29327ce988e838a2ab70a6fb8a557887 Mon Sep 17 00:00:00 2001 From: charlesbvll Date: Mon, 19 Jul 2021 18:58:28 +0200 Subject: [PATCH] better README --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c57e01f..1c5661c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ # rust_os -Small operating system written in the Rust programming language, following this blog : https://os.phil-opp.com/ \ No newline at end of file +Small operating system written in the Rust programming language, following this blog : https://os.phil-opp.com/ + +### Usage + +First you need to install Rust, rustup and QEMU. +Inside the cloned repo you can then run : +``` +rustup override set nightly +rustup component add rust-src +cargo install bootimage +rustup component add llvm-tools-preview +``` + +You should now be able to run `cargo run` to launch the kernel on QEMU. You can also run `cargo test` to test the different parts of the code without having to launch QEMU. \ No newline at end of file