Update Readme

Add Legend, Build information, known problems and little how to contribute
main
Georg Krause 2018-05-07 15:24:32 +02:00 committed by GitHub
parent bf1ab519f9
commit 5b24886fc0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 0 deletions

View File

@ -1,2 +1,27 @@
# luppp-signalflow
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 :)