Docs: Add Mermaid diagram with channel routing #28

README.md

@@ -21,11 +21,12 @@ This project is part of [Aura Radio Software Suite](https://gitlab.servus.at/aur
    2. [Quickstart](#quickstart)
    3. [Audio Store](#audio-store)
    4. [Advanced Configuration](#advanced-configuration)
-   5. [Testing](#testing)
-   6. [Logging](#logging)
-   7. [Other AURA Components](#other-aura-components)
-   8. [Read more](#read-more)
-   9. [About](#about)
+   5. [Channel Routing](#channel-routing)
+   6. [Testing](#testing)
+   7. [Logging](#logging)
+   8. [Other AURA Components](#other-aura-components)
+   9. [Read more](#read-more)
+   10. [About](#about)
 
 <!-- /TOC -->
 
@@ -72,6 +73,25 @@ By default only audio output is enabled using the systems default device. If you
 
 Also review the other settings in your `engine-core.ini` to fine-tune the heart of your engine. If you are experiencing issues also check out the [Frequently Asked Questions (FAQ)](docs/frequently-asked-questions.md).
 
+## Channel Routing
+
+Following diagram shows existing channels and their routing.
+
+```mermaid
+graph TD
+    iq0[Queue A] -->|in_queue_0| mix
+    iq1[Queue B] -->|in_queue_1| mix
+    is0[Stream A] -->|in_stream_0| mix
+    is1[Stream B] -->|in_stream_1| mix
+    il0[LineIn A] -->|in_line_0| mix
+    il1[LineIn B] -->|in_line_1| mix
+    ff[Fallback Folder] -->|fallback_folder| FBK
+    fpls[Fallback Playlist] -->|fallback_playlist| FBK
+    FBK[or] -->| | mix
+    mix[mixer] --> |output.alsa| C[fa:fa-play Line Out]
+    mix[mixer] --> |output.icecast| D[fa:fa-play Icecast]
+```
+
 ## Testing
 
 A basic _Test Suite_ can be executed with