From 71d8a438f73ed27dd05f39fb22df350ce958f70f Mon Sep 17 00:00:00 2001 From: Philipp Oppermann Date: Fri, 17 Jul 2020 11:48:27 +0200 Subject: [PATCH] Update Readme for new build-std build instructions --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index c51fd532..ac443282 100644 --- a/README.md +++ b/README.md @@ -10,19 +10,21 @@ This repository contains the source code for the [A Minimal Rust Kernel][post] p ## Building -You need a nightly Rust compiler. First you need to install the `cargo-xbuild` and `bootimage` tools: +This project required a nightly version of Rust. You can build the project by running: ``` -cargo install cargo-xbuild bootimage +cargo build ``` -Then you can build the project by running: +To create a bootable disk image from the compiled kernel, you need to install the [`bootimage`] tool: + +[`bootimage`]: https://github.com/rust-osdev/bootimage ``` -cargo xbuild +cargo install bootimage ``` -To create a bootable disk image, run: +After installing, you can create the bootable disk image by running: ``` cargo bootimage @@ -39,10 +41,10 @@ You can run the disk image in [QEMU] through: [QEMU]: https://www.qemu.org/ ``` -cargo xrun +cargo run ``` -Of course [QEMU] needs to be installed for this. +[QEMU] and the [`bootimage`] tool need to be installed for this. You can also write the image to an USB stick for booting it on a real machine. On Linux, the command for this is: