/kiwi-rs

Primary LanguageRustApache License 2.0Apache-2.0


Kiwi

A simple and educative micro-kernel written in Rust trying to explore modern concepts
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributing
  4. License
  5. Acknowledgments

About The Project

TODO

(back to top)

Getting Started

Prerequisites

To build this project, you will need to have Rust and rustup installed on your machine. You can install it by following the instructions on the official website.

There are also a few more dependencies in order to build and run the project:

  • qemu for running the kernel in a virtual machine. You can install it with your package manager. Make sure to install the version corresponding to your target architecture (e.g. qemu-system-riscv64 if you want to run the riscv64 kernel).

Building

Clone the repository:

git clone --depth 1 https://github.com/haoud/silicium.git

Build the kernel, servers and userland programs:

make build

Run the kernel in Qemy:

make run

Tip

If you are lost, you can run make help to see all the available commands.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Kiwi is dual-licensed under the Apache License, Version 2.0 and the MIT license. See LICENSE-APACHE and LICENSE-MIT for details.

(back to top)

Acknowledgments

(back to top)