Rustic OS

Rustic OS written completely in Rust

Rustic OS is our attempt at developing a modular kernel written completely in Rust with an attempt to make it as usable for daily driver needs as possible.

Contents

• Dependencies
• Development
• Contributing
• Contact

Dependencies

The dependencies required for compiling and running Rustic OS are Rust and QEMU. Their installation guides are linked below:

• Rust
• QEMU

Development

Open your favourite terminal and perform the following tasks:-

1. Clone this repository.

   $ git clone https://github.com/sdslabs/rusticos

2. Go inside the cloned directory and list available makefile commands.

   $ cd rusticos && make help
   
   RusticOS, Lightweight OS implementation in Rust
   
   install        Install toolchain dependencies
   fmt            Format codebase using cargo fmt
   kernel_build   Build kernel image
   kernel_test    Run kernel tests
   kernel_run     Attach QEMU and run kernel
   
   Do check out the code at https://github.com/sdslabs/rusticos

3. Run make install to install the necessary toolchain dependencies and change Rust version to nightly-2021-12-07.

   This is necessary to enable some of the dependency crates

   $ make install

4. Compile the kernel crate and build the kernel binary and link with the bootloader.

   $ make kernel_build

5. Attach QEMU as the runner and boot up the kernel.

   $ make kernel_run

Contributing

If you'd like to contribute to this project, refer to the contributing documentation.

Contact

If you have a query regarding the product or just want to say hello then feel free to visit chat.sdslabs.co or drop a mail at [email protected]

Created with ❤️ by SDSLabs