Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,11 @@ To see how to specify the output formats, as well as additional options, run:
$ wireviz --help
```

For using the .gv output one needs to use the following command:

```
dot <filename>.gv | gvpr -q -cf <filename>_pin2pin.gvpr | neato -n2 -T<type> -o <filename>.<type>
```

### (Re-)Building the example projects

Expand Down
20 changes: 18 additions & 2 deletions docs/syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,24 @@ tweak: # optional tweaking of .gv output
hide_disconnected_pins: <bool> # defaults to false

# loops
loops: <List> # every list item is itself a list of exactly two pins
# on the connector that are to be shorted
loops: # a list(dict) of loops
- <str>: <List> # every list item is itself a list of pins
# on the connector that are to be shorted with a cable loop
# more information about the loop can be added by additional
# components definition (see below)
# OR
- <List> # a list of pins to be looped
# Shorts
shorts: # a list(dict) of shorts
<str>: <List> # every list item is itself a list of pins
# on the connector that are to be shorted represented inside
# the connector table
# more information about the loop can be added by additional
# components definition (see below)
# OR
- <List> # a list of pins to be shorted
# it is not posable to combine those two
shorts_hide_lable: <bool> # A Boolean to control if the lable of the shorts should be shown, if a list is used this is automatically turned true.
```

## Cable attributes
Expand Down
56 changes: 10 additions & 46 deletions examples/demo01.gv

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading