Update Readme
Add Legend, Build information, known problems and little how to contributemain
parent
bf1ab519f9
commit
5b24886fc0
25
README.md
25
README.md
|
@ -1,2 +1,27 @@
|
||||||
# luppp-signalflow
|
# luppp-signalflow
|
||||||
|
|
||||||
Some graphs to document the signal-flow of Luppp
|
Some graphs to document the signal-flow of Luppp
|
||||||
|
|
||||||
|
# Legend
|
||||||
|
|
||||||
|
- red Box = Jack Output Port
|
||||||
|
- orange Box = Jack Input Port
|
||||||
|
- Blue Box = Internal Connection
|
||||||
|
- Oval = Continous Controller
|
||||||
|
|
||||||
|
# Build
|
||||||
|
|
||||||
|
To build everything to SVG (recommended), use:
|
||||||
|
`dot -Tsvg *.dot -O`
|
||||||
|
|
||||||
|
For more options, see `dot --help`
|
||||||
|
|
||||||
|
# Known Problems
|
||||||
|
|
||||||
|
- long way to go to be complete
|
||||||
|
- no discrete controllers
|
||||||
|
- no crossfaders
|
||||||
|
|
||||||
|
# Contribute
|
||||||
|
|
||||||
|
Help is always welcome, please get in touch by creating an issue, join #openav on freenode or send an email (mail@georg-krause.net). Please feel also free to file any PR if you know something to improve. Thanks :)
|
||||||
|
|
Loading…
Reference in New Issue