oro-os / kernel

Kernel for the Oro Operating System

Oro Operating System

Kernel and associated bootloaders for the Oro Operating System,
a general-purpose, minimal, and novel microkernel operating system written in Rust.
« oro.sh | discord | x »

This is the home of the Oro Operating System kernel and bootloader crates. All code necessary to build and run the kernel is provided in this repository.

Caution

The Oro Operating System is currently in the early stages of development. It is not yet suitable for use in a production environment.

Building

The kernel is built standalone and used as a module for a bootloader entry point. The kernel does not support being booted to directly.

To build the kernel itself:

cargo kernel-x86_64
cargo kernel-aarch64

To build a bootloader:

cargo limine-x86_64
cargo limine-aarch64

Documentation

The Oro kernel is thoroughly documented. You may generate a local copy of the documentation with:

cargo oro-doc-x86_64 --open
cargo oro-doc-aarch64 --open

Security

If you have found a vulnerability within the Oro kernel or any of the associated crates included in this repository, please do not open an issue and instead consult SECURITY.md for instructions on how to responsibly disclose your findings.

License

The Oro Operating System kernel is © 2016-2024 by Joshua Lee Junon, and licensed under the Mozilla Public License 2.0.

kernel's Issues

cargo oro-doc-x86_64 opens documentation for aarch64 in browser

Running the cargo oro-doc-x86_64 --open command given in the README.md will build the documentation as expected, and then proceeds to open <project root>/target/x86_64-unknown-oro/doc/oro_arch_aarch64/index.html.

Support --offline builds

Could be done one of two ways:

• cargo vendor and a CI script to check if the dependencies match the lockfiles
• Forks + submodules, then using CI to automatically pull new versions when needed
• Combination of the two.

Regardless of if we want to go the vendoring route or submodule route (I'm leaning toward the latter), this is still blocked on rust-lang/wg-cargo-std-aware#23.