colmena/manual/README.md

10 lines
339 B
Markdown
Raw Normal View History

# Documentation
You can read the rendered version [here](https://zhaofengli.github.io/colmena).
## Building the Documentation
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.