Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ehne authored Jun 26, 2020
1 parent 88dd414 commit 848a11f
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ to install ERDot:

```pip install ERDot```

you may also need to [install graphvis](https://graphviz.org/download/) to be able to create images of the dot files generated.
you may also need to [install graphvis](https://graphviz.org/download/) to be able to create images of the dot files generated. If you don't want to install graphviz, you can copy the contents of the generated dot file into an [online grapviz viewer](https://edotor.net).

## CLI Usage
```
Expand All @@ -32,14 +32,16 @@ Options:
--help Show this message and exit.
```

Note that after generating the .dot file, you will still need to output it to your desired format using graphvis. An example of how to do this:
Note that after generating the .dot file, you will still need to output it to your desired format using graphviz. An example of how to do this:

```bash
erdot -i inputFile.erd.json

dot ERDotOutput.dot -Tpng -o imageFile.png
```

(You could also copy and paste the contents of the .dot file into an [online graphviz viewer](https://edotor.net))

## ERDJSON format:
```json
{
Expand Down

0 comments on commit 848a11f

Please sign in to comment.