Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Suggest installing graphviz before book building #4565

Merged
merged 1 commit into from
Dec 20, 2021
Merged

Suggest installing graphviz before book building #4565

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions roadmap/implementers-guide/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down