Suggest installing graphviz before book building (#4565)

This commit is contained in:
jmole
2021-12-20 01:41:30 -08:00
committed by GitHub
parent 78c3284ce7
commit a5bbe0d0be
@@ -3,6 +3,14 @@
The implementers' guide is compiled from several source files with [`mdBook`](https://github.com/rust-lang/mdBook).
To view it live, locally, from the repo root:
Ensure graphviz is installed:
```sh
brew install graphviz # for macOS
sudo apt-get install graphviz # for Ubuntu/Debian
```
Then install and build the book:
```sh
cargo install mdbook mdbook-linkcheck mdbook-graphviz
mdbook serve roadmap/implementers-guide