From 5b24886fc0543dc627451ea658225292c5759c72 Mon Sep 17 00:00:00 2001 From: Georg Krause Date: Mon, 7 May 2018 15:24:32 +0200 Subject: [PATCH] Update Readme Add Legend, Build information, known problems and little how to contribute --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 5ee88fa..e4a8743 100644 --- a/README.md +++ b/README.md @@ -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 :)