Add instructions to run the kernel
Signed-off-by: Noah Knegt <git@noahknegt.com>
This commit is contained in:
22
README.md
22
README.md
@@ -2,3 +2,25 @@
|
|||||||
|
|
||||||
A custom OS written in Rust
|
A custom OS written in Rust
|
||||||
|
|
||||||
|
## Running the OS
|
||||||
|
|
||||||
|
You can start running the OS by executing:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cargo run
|
||||||
|
```
|
||||||
|
|
||||||
|
This assumes that you have a rust environment setup and cargo is available, the easiest way to do this is with [rustup](https://rustup.rs/).
|
||||||
|
|
||||||
|
### Dependencies
|
||||||
|
|
||||||
|
You should have the command `qemu-system-x86_64` available on your system to run the OS through an emulator, although it is also possible to flash it on an USB-drive and boot it directly.
|
||||||
|
For debian users you can install the [`qemu-system-x86`](https://packages.debian.org/sid/qemu-system-x86) package and that will make sure all dependencies for the emulator are correctly installed.
|
||||||
|
|
||||||
|
### Install to USB-drive
|
||||||
|
|
||||||
|
To install it to an USB-drive you can use the following command if you are on a linux system.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo dd if=<path-to-project>/target/<config>/FerrOS of=/dev/sdX bs=1M status=progress
|
||||||
|
```
|
||||||
|
Reference in New Issue
Block a user