Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
It needs to have graphviz installed.
  • Loading branch information
JpOnline authored Jun 5, 2019
1 parent 00c43a1 commit 1eb3acb
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,14 @@ Which will be visualized like this:

![A vizualization of an example system](example.svg)

Use of this project requires that [Graphviz](http://www.graphviz.org) is installed, which can be checked by running `dot -V` at the command line. If it's not installed, you can do the following:

| platform | directions |
|----------|------------|
| Linux | install `graphviz` using your package manager |
| OS X | use `brew install graphiz` or [download the installer](http://www.graphviz.org/Download_macos.php) |
| Windows | [download the installer](http://www.graphviz.org/Download_windows.php) |

## Contributing

PRs and feature requests welcome.
Expand Down

0 comments on commit 1eb3acb

Please sign in to comment.