Skip to content

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

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.

Sign up for GitHub

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

Merged
merged 7 commits into from
Oct 18, 2022
Merged

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

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1826dfb
Give clarity for installating dependencies and add pip command for Gr…
AfiMaameDufie Oct 16, 2022
1606e29
Making requested changes for Graphviz command and pip argument
AfiMaameDufie Oct 17, 2022
57462ac
Merge branch 'common-workflow-language:main' into Impr/Building_Secti…
AfiMaameDufie Oct 17, 2022
651991d
Added a section on the need for dot and related info
AfiMaameDufie Oct 18, 2022
44fc9ac
Merge branch 'Impr/Building_Section_in_the_CONTRIBUTION.md' of github…
AfiMaameDufie Oct 18, 2022
b4336cb
Update CONTRIBUTING.md
mr-c Oct 18, 2022
1f18523
Update CONTRIBUTING.md
mr-c Oct 18, 2022
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
11 changes: 9 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,14 +102,21 @@ tool. You must have a recent version of Python 3.6+ installed to build the proje
locally. It is also recommended having `make` (otherwise look at the commands used
in `Makefile`).

The `dot` program from Graphviz is needed to render some of the diagrams.

* For Debian/Ubuntu users:
```bash
sudo apt get install graphviz
```
* For non-Debian/Ubuntu users, follow the directions at [the GraphViz download site](https://graphviz.org/download).
```bash
# Create and activate a virtual environment
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.
(venv) pip install ".[all]"
# Create the HTML to visualize locally
(venv) make html
(venv) open _build/index.html
Expand Down