From aefc368d4193c7e545030264d03c50227bed7a23 Mon Sep 17 00:00:00 2001 From: zxq5 Date: Mon, 24 Feb 2025 03:44:22 +0000 Subject: [PATCH] updated readme for more comprehensive build instructions --- README.md | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index cb0c9b8..fe30d89 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,21 @@ # FoundryOS -## Cloning and building +## Build dependencies -Here are some simple steps to get started: +* latest rust nightly release +* all necessary rust components installed +* xorriso: creates ISO images to be booted from. +* (Optional / Recommended) Qemu: to run the kernel. (this may be packaged as qemu-desktop) +* (Optional) GDB: for debugging the kernel. +```sh +rustup update +rustup override set nightly +rustup component add rust-src +rustup component add llvm-tools-preview +``` + +## Building & Running in Qemu: ```sh git clone https://git.zxq5.dev/OsDev/FoundryOS.git cargo run @@ -13,12 +25,3 @@ cargo run ```sh USE_GDB=1 cargo run ``` - -### Build dependencies - -* libisoburn: creates ISO images to be booted from. -* qemu: to run the kernel. - -Optionally, - -* GDB: for debugging the kernel. \ No newline at end of file