updated readme for more comprehensive build instructions
This commit is contained in:
@@ -1,9 +1,21 @@
|
|||||||
# FoundryOS
|
# 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
|
```sh
|
||||||
git clone https://git.zxq5.dev/OsDev/FoundryOS.git
|
git clone https://git.zxq5.dev/OsDev/FoundryOS.git
|
||||||
cargo run
|
cargo run
|
||||||
@@ -13,12 +25,3 @@ cargo run
|
|||||||
```sh
|
```sh
|
||||||
USE_GDB=1 cargo run
|
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.
|
|
||||||
Reference in New Issue
Block a user