Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/c1m50c/rust-os
Repository loosely following the "Writing an Operating System in Rust" blog by Philipp Oppermann.
https://github.com/c1m50c/rust-os
actions github-actions kernel qemu rust rust-lang rust-os
Last synced: 22 days ago
JSON representation
Repository loosely following the "Writing an Operating System in Rust" blog by Philipp Oppermann.
- Host: GitHub
- URL: https://github.com/c1m50c/rust-os
- Owner: c1m50c
- License: apache-2.0
- Created: 2023-04-13T03:24:56.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-09T17:33:41.000Z (over 1 year ago)
- Last Synced: 2024-11-18T16:57:43.049Z (3 months ago)
- Topics: actions, github-actions, kernel, qemu, rust, rust-lang, rust-os
- Language: Rust
- Homepage: https://os.phil-opp.com/
- Size: 41 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# rust-os
[](https://github.com/c1m50c/rust-os/actions/workflows/verify.yaml)
Repository following the ["Writing an Operating System in Rust"] blog by Philipp Oppermann.
["Writing an Operating System in Rust"]: https://os.phil-opp.com/
## Installing Requirements
### Compilation Tools
This operating system is written in Rust so you'll need to install the language's compilation tools by running the following commmands:
#### Windows
```bash
$ choco install rust
```
#### MacOS
```bash
$ brew install rust
```
### Nightly Channel
Alongside the normal compilation toolkit you'll need to add the [`nightly`] channel to your [`rustup`] installation, you can do so by running the following commands:
```bash
$ rustup update
> ...
$ rustup toolchain install nightly
> ...
# Also add the `x86_64-unknown-none` build target for compiling our kernel.
$ rustup target add x86_64-unknown-none
```
[`rustup`]: https://rust-lang.github.io/rustup/index.html
[`nightly`]: https://rust-lang.github.io/rustup/concepts/channels.html#working-with-nightly-rust
### QEMU
Lastly, you'll need to install [QEMU] to emulate our operating system. To do so, follow the [installation instructions] for the platform you're currently using.
[QEMU]: https://www.qemu.org/
[installation instructions]: https://www.qemu.org/download/
## Running
After you've installed all of the requirements, running the operating system should be as simple as executing any of the following commands:
```bash
$ cargo run --release -- help
> ... # Help menu will pop up displaying a valid list of commands
$ cargo run --release -- uefi
> ... # QEMU Window should pop up launching our kernel's UEFI image
$ cargo run --release -- bios
> ... # QEMU Window should pop up launching our kernel's BIOS image
```
## Testing
Due to the way this currently setup, testing is a bit funky. You can run the following commands to launch the kernel in test mode:
```bash
# This can be set to any value, as long as its present the kernel will be compiled in test mode.
$ export KERNEL_TEST_MODE="true"
$ cargo run --release -F testing --
> ...
```