Skip to content

Commit 5059b53

Browse files
author
Fückert, Oliver
committed
Update Headings
1 parent 9756b33 commit 5059b53

1 file changed

Lines changed: 32 additions & 4 deletions

File tree

README.md

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,41 @@
22

33
aci2dot converts JSON formatted Cisco ACI policy files or snippets to a [DOT](https://en.wikipedia.org/wiki/DOT_(graph_description_language)) graph format.
44

5+
![ACI Policy Graph](example/bgp.svg "ACI Policy Graph")
6+
7+
## Dependencies
8+
59
It requires Python 3. [Graphwiz](https://www.graphviz.org) is not required as long as the option --dot is not used.
610
When [Graphwiz](https://www.graphviz.org) is installed `--dot {svg,png,pdf}` will also render the graph in the respective format.
711

12+
## Customisation
13+
814
`--write` creates a config file `.aci2dot` in the current directory, which allows for modification of the graph, node and edge properties.
915

16+
The default config is as following:
17+
```
18+
graph [
19+
size="8.27";
20+
ratio="1";
21+
nodesep="0.15";
22+
ranksep="0.5";
23+
#splines="false";
24+
#rankdir=LR;
25+
bgcolor="transparent";
26+
];
27+
node [
28+
shape=box;
29+
style="rounded,filled";
30+
fillcolor=AZURE;
31+
fontname=Helvetica;
32+
]
33+
edge [
34+
#arrowsize=0.5;
35+
]
36+
```
37+
38+
## Full usage
39+
1040
```
1141
./aci2dot.py --help
1242
usage: aci2dot.py [-h] [--nr] [--na] [--write]
@@ -27,11 +57,9 @@ optional arguments:
2757
--dot {svg,png,pdf} Also write SVG/PNG/PDF. 'dot' needs to be installed.
2858
```
2959

30-
For example:
31-
32-
![ACI Policy Graph](example/bgp.svg "ACI Policy Graph")
60+
## Example
3361

34-
was rendered from:
62+
The example graph above was rendered from:
3563

3664
```json
3765
{

0 commit comments

Comments
 (0)