Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add clarity for installing dependencies and pip command for Graphviz #304

6 changes: 4 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,10 +103,12 @@ python -m venv venv
source venv/bin/activate
# update the version of pip, setuptools, and wheel
(venv) pip install -U pip setuptools wheel
# Install the dependencies in your virtual environment
(venv) pip install .[all]
# Install all the dependencies in your virtual environment.
# The dot or period at the end means that the dependencies are referenced is in the same directory as the current location).
(venv) pip install .
mr-c marked this conversation as resolved.
Show resolved Hide resolved
# Create the HTML to visualize locally
(venv) make html
(venv) pip install graphviz
mr-c marked this conversation as resolved.
Show resolved Hide resolved
(venv) open _build/index.html
# Or you can start a serve that watches for local file changes
(venv) make watch
Expand Down