diff --git a/readme.md b/readme.md index 7cc8375..45f2743 100644 --- a/readme.md +++ b/readme.md @@ -2,7 +2,7 @@ ## 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. @@ -93,11 +93,11 @@ GraphViz code generated by parser: ## Status -This is very much a work in progress, and mainly an idea in my head. -A Python module and test scripts is available. Running the test script will generate GraphViz output. +This is very much a work in progress. +A Python module and test scripts are available. Running the test script will generate GraphViz output. The parser will follow later; contributions are welcome! -# To do +## To do * Automate creation of left/right side ports for connectors * Add simple connectors (ferrules, cable lugs)