Update readme
This commit is contained in:
parent
bbb38e7d9b
commit
6c9d4151d5
28
readme.md
28
readme.md
@ -1,25 +1,23 @@
|
||||
# WireViz
|
||||
|
||||
## Problem
|
||||
## Summary
|
||||
|
||||
There is no easy way to document wires in projects.
|
||||
WireViz is a simple yet flexible markup language for documenting wires and connector pinouts with beautiful graphical output.
|
||||
|
||||
## Solution
|
||||
|
||||
Create a GraphViz-based markup language and parser to quickly and easily document cables, wires and pinouts.
|
||||
|
||||
## Requirements
|
||||
|
||||
* Must be text based for easy version control
|
||||
* Must be easy to use, yet flexible and extendable
|
||||
It is based on GraphViz and designed as an "extension" of it. A parser reads a WireViz and generates valid GraphViz output, which can instantly be rendered to SVG/PNG.
|
||||
|
||||
## Features
|
||||
|
||||
* Auto-generate standard wire color schemes and allow custom ones
|
||||
* WireViz is fully text based
|
||||
* No special editor required
|
||||
* Human readable
|
||||
* Easy version control
|
||||
* GraphViz-like syntax
|
||||
* Auto-generates standard wire color schemes and allows custom ones if needed
|
||||
* DIN 47100 (WT/BN/GN/YE/GY/PK/BU/RD/BK/VT/...)
|
||||
* IEC ??? (BN/RD/OR/YE/GN/BU/VT/GY/WT/BK/...)
|
||||
* Allow more than one connector per side
|
||||
* Include image with pinout of connector, if known
|
||||
* Allows more than one connector per side, as well as loopbacks
|
||||
* Will include images of known connectors, together with their pinouts
|
||||
|
||||
## Example
|
||||
|
||||
@ -80,3 +78,7 @@ GraphViz code generated by parser:
|
||||
X1:p5 -> W1:wsi;
|
||||
X2:p5:w -> X2:p6:w
|
||||
}
|
||||
|
||||
## Status
|
||||
|
||||
This is very much a work in progress, and mainly an idea in my head.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user