]> gitweb.hhaalo.de Git - sane-kds-s2000w-net.git/commitdiff
add main architecture flow diag in readme
authorBastian Dehn <hhaalo@arcor.de>
Wed, 31 Jul 2024 14:46:41 +0000 (16:46 +0200)
committerBastian Dehn <hhaalo@arcor.de>
Wed, 31 Jul 2024 14:46:41 +0000 (16:46 +0200)
readme.md

index 4b1d229f79173ef4095146866af54eee7497766a..3fd7904ac08c8addc1cf5c1c3f77911d452fa242 100644 (file)
--- a/readme.md
+++ b/readme.md
@@ -17,6 +17,7 @@ https://support.alarisworld.com/de-de/s2080w-scanner#Software
 2. [Build](#build)
 3. [Configuration](#configuration)
 4. [Develop with Tests](#develop-with-tests)
+5. [Architecture](#architecture)
 
 ## Dependencies
 
@@ -92,4 +93,17 @@ build with debug symboles
 ```bash
 cmake -DCMAKE_BUILD_TYPE=DEBUG ..
 make
+```
+
+## Architecture
+
+The diagram is created with Markdown Preview Mermaid Support plugin for VSCode.
+
+```mermaid
+flowchart TD
+
+subgraph main flow components
+       kds_s2000w_net --> kds_s2000w_handler
+       kds_s2000w_handler --> kds_s2000w_client
+end
 ```
\ No newline at end of file