Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Overview
This crate enables the user to create a simple operating system by supplying interrupt handlers for the timer and the keyboard. As time and energy permits, I may add other interrupt handlers that seem useful.
I developed this crate to support two assignments in my operating systems course at Hendrix College. It provides a nice introduction to bare-metal programming. It has not been "battle-tested" in a production domain.
The code is heavily derivative of the examples from the outstanding resource Writing an Operating System in Rust. I would like to gratefully acknowledge Phillipp Oppermann's efforts to create this resource. Comments in each source file specify which code elements I have adopted from him.
Before attempting to use this crate, it is essential to read the following tutorials. In fact, don't just read the tutorials; work through them! In particular, make sure to set up the x86_64-blog_os.json file and the .cargo/config.toml file as described therein.
- A Freestanding Rust Binary
- A Minimal Rust Kernel
- VGA Text Mode
- CPU Exceptions
- Double Faults
- Hardware Interrupts
Having read and understood the ideas from the above tutorials, you can use this crate to create your own Pluggable Interrupt Operating System (PIOS).
This is a pedagogical experiment. I would be interested to hear from anyone who finds this useful or has suggestions.