FerrOS/README.md

# FerrOS

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
```
Initial commit 2025-07-20 14:17:37 +02:00			`# FerrOS`

feat(OS): Create basic kernel that can be run through both QEMU and on hardware (#1) Reviewed-on: https://git.noahknegt.com/noah.knegt/FerrOS/pulls/1 2025-07-20 21:15:05 +02:00			`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`
			```