From a5bbe0d0bee14b4ed53f26c0d01a62286196a92b Mon Sep 17 00:00:00 2001 From: jmole <jmoeller@gmail.com> Date: Mon, 20 Dec 2021 01:41:30 -0800 Subject: [PATCH] Suggest installing graphviz before book building (#4565) --- polkadot/roadmap/implementers-guide/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/polkadot/roadmap/implementers-guide/README.md b/polkadot/roadmap/implementers-guide/README.md index 4f68ae02a5e..70a10a26a76 100644 --- a/polkadot/roadmap/implementers-guide/README.md +++ b/polkadot/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 -- GitLab