https://github.com/0xflux/velox

Velox is a work in progress, experimental Rust based Operating System written for fun and learning
https://github.com/0xflux/velox

computer-science computerscience operating operating-system operatingsystem os os-dev os-development rust rust-os rust-os-dev system

Last synced: about 1 year ago
JSON representation

Velox is a work in progress, experimental Rust based Operating System written for fun and learning

• Host: GitHub
• URL: https://github.com/0xflux/velox
• Owner: 0xflux
• Created: 2025-05-06T20:57:10.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2025-05-06T21:12:59.000Z (about 1 year ago)
• Last Synced: 2025-05-12T01:54:13.493Z (about 1 year ago)
• Topics: computer-science, computerscience, operating, operating-system, operatingsystem, os, os-dev, os-development, rust, rust-os, rust-os-dev, system
• Language: Rust
• Homepage:
• Size: 231 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

          
# Velox OS

Velox is a **work in process** minimal Operating System built in **Rust** as a hobby project for 

low level systems engineering (in Rust).

With thanks to the guide at [phil-opp.com](https://os.phil-opp.com/minimal-rust-kernel/). I hope to turn

this project into a more fleshed out OS for funsies, beyond the start-up topics from the linked blog! :)

[mit.edu](https://pdos.csail.mit.edu/6.828/2018/labs/lab1/index.html) also has some great resources for basic OS dev!

![Hello world!](media/image.png)

# Building

To build, we use the [bootloader](https://crates.io/crates/bootloader) crate (pinned to v0.9) and 

running `cargo bootimage` from within the project crate. See requirements for installation instructions.

After executing `cargo bootimage`, there should be a bootable image at `/target/x86_64-velox/*/bootimage-velox.bin`.

To run (assisted, ensure qemu installed): `cargo run`.

To run (un-assisted): `qemu-system-x86_64 -drive format=raw,file=target/x86_64-velox/debug/bootimage-velox.bin`.

# Requirements

- `rustup override set nightly`

- `rustup component add rust-src`

- `rustup component add llvm-tools-preview`

- Install [QEMU](https://www.qemu.org/download/):

  - MacOS: `brew install qemu`

- (from outside the cargo project) `cargo install bootimage`