asterinas/docs/README.md
Tate, Hongliang Tian 7e4e3fd643 Add README for docs
2022-08-08 12:26:50 -07:00

14 lines
300 B
Markdown

# 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
```