mirror of
https://github.com/asterinas/asterinas.git
synced 2025-06-09 05:16:47 +00:00
Add README for docs
This commit is contained in:
parent
92d29e2030
commit
7e4e3fd643
14
docs/README.md
Normal file
14
docs/README.md
Normal 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
|
||||
```
|
Loading…
x
Reference in New Issue
Block a user