From 7e4e3fd64383bb6ef05992862fced001891115db Mon Sep 17 00:00:00 2001 From: "Tate, Hongliang Tian" Date: Mon, 8 Aug 2022 12:26:50 -0700 Subject: [PATCH] Add README for docs --- docs/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..b4c9b3445 --- /dev/null +++ b/docs/README.md @@ -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 +``` \ No newline at end of file