📝 added puml diagram

.github/workflows/latex.yml

@@ -20,7 +20,7 @@ jobs:
           compiler: pdflatex
           args: -interaction=nonstopmode -shell-escape
       - name: prepare folder
-        run: mkdir docs && cp manual/manual.pdf docs
+        run: mkdir -p docs && cp manual/manual.pdf docs
 
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ornithology-pi"
-version = "0.1.0"
+version = "0.2.0"
 edition = "2021"
 authors = ["Christian <[email protected]>"]
 description = "Capture birds in your garden, running on raspberry pi."

README.md

@@ -1,6 +1,8 @@
 # OrnithologyPi
 Capture birds in your garden, running on raspberry pi.
 
+![Overview](https://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/chriamue/ornithology-pi/main/docs/overview.puml)
+
 ## Quickstart
 
 ### Webcam example

docs/overview.puml

@@ -0,0 +1,37 @@
+@startuml overview
+
+node Browser {
+    card WebPage
+    card LocalPage
+}
+
+node RaspberryPi {
+    card HTTP
+    card Bluetooth
+
+    node OrnithologyApp {
+        card Capture
+        card CropImage
+        card IdentifyBird
+        card ServeDetection
+        card Server
+        card Gatt
+    }
+}
+
+card WebCam
+
+WebPage --> Bluetooth
+LocalPage --> HTTP
+
+WebCam --> Capture
+Capture --> Server
+Capture -> CropImage
+CropImage -> IdentifyBird
+IdentifyBird -> ServeDetection
+ServeDetection -> Server
+Server --> HTTP
+ServeDetection -> Gatt
+Gatt --> Bluetooth
+
+@enduml

ornithology-pi.toml

@@ -1,3 +1,7 @@
 [default.shutdown]
 ctrlc = false
 signals = ["term", "hup"]
+
+[release]
+port = 8000
+address = "0.0.0.0"