From c919b66b6e98e983d3862a448d7cae07e5fb857d Mon Sep 17 00:00:00 2001 From: Ryan Brue Date: Sep 16 2024 04:43:32 +0000 Subject: Add info on how to build the documentation Signed-off-by: Ryan Brue --- diff --git a/README.md b/README.md index 87ea540..424de5e 100644 --- a/README.md +++ b/README.md @@ -8,4 +8,11 @@ Be sure to report issues with the packaging in this repo. Report COSMIC related # Documentation -See: [docs/index.md](docs/index.md) \ No newline at end of file +To build the documentation, install `mdbook` and build the `docs` folder: + +```shell +cargo install mdbook +mdbook build docs +``` + +You can also serve a live webserver for the docs with `mdbook serve docs` \ No newline at end of file diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 92bdef7..ed685dc 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -2,3 +2,4 @@ - [Welcome](./index.md) - [Building for Rawhide](./building-for-rawhide.md) +- [Generating license](./generating-license.md)