Add documentation and port to python3.
This commit is contained in:
parent
73ec40414e
commit
8b14daf190
3 changed files with 36 additions and 8 deletions
23
readme.md
Normal file
23
readme.md
Normal file
|
@ -0,0 +1,23 @@
|
|||
# Polygraph - polycule visualization for nerds
|
||||
|
||||
This program is a thin shell on top of pygraphviz aimed at making it easy to draw a graph of your polyamorous network.
|
||||
|
||||
It can, of course, be trivially used for anyone who wants a quick way to define a graph and render it; it's just
|
||||
a thin shell on top of a few of pygraphviz' features. Feel free to use it for anything that seems useful to you!
|
||||
|
||||
## Installation
|
||||
|
||||
On Ubuntu, just run:
|
||||
|
||||
```
|
||||
sudo apt install graphviz-dev python3-pydot
|
||||
pip3 install -r requirements.txt
|
||||
```
|
||||
|
||||
Now you can define a graph file and run the tool with:
|
||||
|
||||
```
|
||||
./polygraph.py -i <input_file.json> -o <output_file.json>
|
||||
```
|
||||
|
||||
See `./polygraph.py --help` for more detailed options.
|
Loading…
Add table
Add a link
Reference in a new issue