Skip to content

Commit 4d968b7

Browse files
AfiMaameDufiemr-c
andauthored
Add clarity for installing dependencies and pip command for Graphviz (#304)
Co-authored-by: Michael R. Crusoe <[email protected]>
1 parent b751753 commit 4d968b7

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,14 +102,21 @@ tool. You must have a recent version of Python 3.6+ installed to build the proje
102102
locally. It is also recommended having `make` (otherwise look at the commands used
103103
in `Makefile`).
104104

105+
The `dot` program from Graphviz is needed to render some of the diagrams.
106+
107+
* For Debian/Ubuntu users:
108+
```bash
109+
sudo apt get install graphviz
110+
```
111+
* For non-Debian/Ubuntu users, follow the directions at [the GraphViz download site](https://graphviz.org/download).
105112
```bash
106113
# Create and activate a virtual environment
107114
python -m venv venv
108115
source venv/bin/activate
109116
# update the version of pip, setuptools, and wheel
110117
(venv) pip install -U pip setuptools wheel
111-
# Install the dependencies in your virtual environment
112-
(venv) pip install .[all]
118+
# Install all the dependencies in your virtual environment.
119+
(venv) pip install ".[all]"
113120
# Create the HTML to visualize locally
114121
(venv) make html
115122
(venv) open _build/index.html

0 commit comments

Comments
 (0)