warehack.ing/WireViz
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Daniel Rojas 2020-05-23 20:15:31 +02:00
parent ff94b475c4
commit 5278904234
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
readme.md
View File

@ -2,7 +2,7 @@
## Summary ## Summary
WireViz is a simple yet flexible markup language for documenting wires and connector pinouts with beautiful graphical output. WireViz is a simple yet flexible markup language for documenting cables, wiring harnesses and connector pinouts with beautiful graphical output.
It is based on [GraphViz](https://www.graphviz.org/) and designed as an "extension" of it. A parser reads a WireViz file and generates valid GraphViz output, which can instantly be rendered to SVG/PNG. It is based on [GraphViz](https://www.graphviz.org/) and designed as an "extension" of it. A parser reads a WireViz file and generates valid GraphViz output, which can instantly be rendered to SVG/PNG.
@ -93,11 +93,11 @@ GraphViz code generated by parser:
## Status ## Status
This is very much a work in progress, and mainly an idea in my head. This is very much a work in progress.
A Python module and test scripts is available. Running the test script will generate GraphViz output. A Python module and test scripts are available. Running the test script will generate GraphViz output.
The parser will follow later; contributions are welcome! The parser will follow later; contributions are welcome!
# To do ## To do
* Automate creation of left/right side ports for connectors * Automate creation of left/right side ports for connectors
* Add simple connectors (ferrules, cable lugs) * Add simple connectors (ferrules, cable lugs)