Suggest installing graphviz before book building (#4565)

paritytech · Jan 4, 2022 · 4fa9e04 · 4fa9e04
1 parent 435606f
commit 4fa9e04
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/roadmap/implementers-guide/README.md b/roadmap/implementers-guide/README.md
@@ -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