From 07bd723c11be9f26176f84183f4c6258cfde1a0e Mon Sep 17 00:00:00 2001
From: Jonas Smedegaard <dr@jones.dk>
Date: Wed, 2 Apr 2025 07:31:45 +0200
Subject: add notes about TODO annotations; add component diagram

---
 Mussel/components.puml | 13 +++++++++++++
 report.qmd             | 34 ++++++++++++++++++++++++----------
 2 files changed, 37 insertions(+), 10 deletions(-)
 create mode 100644 Mussel/components.puml

diff --git a/Mussel/components.puml b/Mussel/components.puml
new file mode 100644
index 0000000..dd09477
--- /dev/null
+++ b/Mussel/components.puml
@@ -0,0 +1,13 @@
+@startuml
+interface Bluetooth
+package Sensor {
+[Read] - [Normalize]
+[Normalize] -down- Bluetooth
+}
+package Vote {
+Bluetooth -down- [Collect]
+[Collect] - [Align]
+[Align] - [Qualify]
+[Qualify] - [Conclude]
+}
+@enduml
diff --git a/report.qmd b/report.qmd
index 5fc9e23..3529ee0 100644
--- a/report.qmd
+++ b/report.qmd
@@ -24,7 +24,11 @@ breaks: false
 
 # Abstract
 
-TODO
+*TODO*
+
+*NOTE TO EDITORS:
+TODO notes like this are annotations targeted authors and editors;
+they are **not** intended for inclusion in the final delivery.*
 
 # Introduction
 
@@ -83,21 +87,25 @@ under the Creative Commons crediting share-alike 4.0.
 
 # Project Planning
 
-TODO
+*TODO*
 
 # Analysis and Design
 
-TODO
+*TODO*
 
 # Description of the Program
 
-Use of the library in a sketch...
+The system consists of two parts,
+the sensor system on each mussel
+and the vote handling system...
+
+*TODO*
 
 ```{.plantuml}
-!include Mussel/examples/seconds/seconds.puml
+!include Mussel/components.puml
 ```
 
-TODO
+*TODO*
 
 ## Library function `begin()`
 
@@ -113,19 +121,25 @@ TODO
 
 # User Guide
 
-TODO
+Concrete use of the library in a sketch involves...
+*TODO*
+
+```{.plantuml}
+!include Mussel/examples/seconds/seconds.puml
+```
+*TODO*
 
 # Testing
 
-TODO
+*TODO*
 
 # Discussion
 
-TODO
+*TODO*
 
 # Conclusion
 
-TODO
+*TODO*
 
 # Bibliography {.appendix}
 
-- 
cgit v1.2.3