This project is
- an educational, modern operating system kernel
- completely written in pure, idiomatic Rust (and assembly where required),
- licensed under the GNU Public License v3 or later, except for those parts (lines of code from libraries used in this project) already licensed under other licenses,
- documented in its entirety: the code via Doc comments, the rest via Markdown and GitHub Pages.
The documentation is hosted on GitHub Pages; it contains instructions on how to get started. If you want to serve the documentation locally, you can run the following command from the repository root:
docker run --rm -it -v ./documentation:/docs -p 8080:8080 docker.io/squidfunk/mkdocs-material:9.5.4 serve --dev-addr 0.0.0.0:8080