From 290b39106980c8c71e9cf8b5e581217cecc34991 Mon Sep 17 00:00:00 2001 From: Noah Knegt Date: Sun, 20 Jul 2025 20:06:04 +0200 Subject: [PATCH] Add instructions to run the kernel Signed-off-by: Noah Knegt --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index d3c0425..83e5ba0 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,25 @@ 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=/target//FerrOS of=/dev/sdX bs=1M status=progress +```