diff --git a/polkadot/roadmap/implementers-guide/README.md b/polkadot/roadmap/implementers-guide/README.md index 4f68ae02a5eec306c6003454738baa2cc4e65c3f..70a10a26a76513a5d392ce951db630e0c0b6ff37 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