Add README for docs

This commit is contained in:
Tate, Hongliang Tian 2022-08-08 12:26:50 -07:00
parent 92d29e2030
commit 7e4e3fd643

14
docs/README.md Normal file
View File

@ -0,0 +1,14 @@
# KxOS Documentation
The documentation is rendered as a book with [mdBook](https://rust-lang.github.io/mdBook/),
which can be installed with `cargo`.
```bash
cargo install mdbook
```
To build the book and read it in your default browser, run the following command.
```bash
mdbook serve --open
```