colmena/manual/README.md
2021-11-17 22:40:02 -08:00

9 lines
325 B
Markdown

# Manual
You can read the rendered version [here](https://zhaofengli.github.io/colmena).
## Building the Manual
The manual is rendered using [mdBook](https://github.com/rust-lang/mdBook).
To build the manual, do `nix build .#manual`.
You can also do `nix build .#manualFast` for a version without the CLI usage reference.