Vogelalbum 1.0.0

Eine Kamera am Vogelhaus, ein Rechner der erkennt wer da war — und eine
Sammlung, die sich von allein fuellt.

Zwei neuronale Netze: eines findet den Vogel im Bild, eines bestimmt die
Art. 148 heimische Arten, auf Deutschland eingeschraenkt und neu normiert —
ohne diese Einschraenkung wird aus einer Kohlmeise eine nordamerikanische
Schwesterart. Daraus entsteht ein Sammelalbum: nummerierte Seiten,
gefundene Arten in Farbe, fehlende als Schatten, dazu Erstfang, Punkte,
Stufen und 15 Abzeichen.

Laeuft vollstaendig auf eigener Hardware. Kein Cloud-Dienst, kein Konto,
keine Telemetrie; die Bilder verlassen das eigene Netz nicht.

Zwei getrennt deploybare Teile: die Sammlung als Django-Anwendung, die
Erkennung als eigener Dienst. Der Erkennungs-Dienst fragt selbst an und
braucht deshalb weder eine erreichbare Adresse noch einen offenen Port —
er laeuft hinter einem gewoehnlichen Router.

Dabei: Firmware fuer Raspberry Pi und ESP32-S3, Anbindung an Home
Assistant ueber MQTT, Oberflaeche auf Deutsch und Englisch, Einstellungen
je Kamera aus dem Browser, und ein Weg fuer Fotos von unterwegs.

AGPL-3.0.

docs/README.md

@@ -0,0 +1,57 @@
+# Die Vogelalbum-Dokumentation
+
+<sub>[← zurück zum Überblick](../README.md)</sub>
+
+Das [README](../README.md) beantwortet, *was* Vogelalbum ist und wie man es in
+drei Zeilen startet. Hier steht alles andere.
+
+## Wie es aussieht
+
+| | |
+|---|---|
+| ![Die Sammlung](sammlung.png) | ![Eine Art](artseite.png) |
+| **Die Sammlung** — 148 Arten, gesehene in Farbe, der Rest als Schatten mit Fragezeichen | **Eine Art** — Foto, Steckbrief, Erstfang und alle Besuche |
+| ![Die Sichtungen](sichtungen.png) | ![Die Abzeichen](abzeichen.png) |
+| **Die Sichtungen** — jeder Besuch mit Foto, Dauer und Sicherheit | **Die Abzeichen** — fünfzehn Stück, vom Erstfang bis zu tausend Besuchen |
+| ![Dunkles Thema](startseite-dunkel.png) | ![Auf dem Telefon](handy.png) |
+| **Dunkel** — folgt dem System, umschaltbar im Kopf | **Auf dem Telefon** — dieselbe Seite, keine eigene App nötig |
+
+## Einrichten
+
+| Kapitel | worum es geht |
+|---|---|
+| **[Installation](installation.md)** | mit und ohne Docker, Schritt für Schritt |
+| **[Die Kamera anschließen](kamera.md)** | Stream-Formate, Schwellwerte, Nachtabschaltung — und wie groß ein Vogel im Bild sein muss |
+| **[Einstellungen](einstellungen.md)** | alle Umgebungsvariablen, und was stattdessen im Admin geht |
+
+Die Kameraseiten haben eigene Anleitungen, weil sie auf eigener Hardware
+laufen: **[Raspberry Pi](../pi/README.md)** und **[ESP32-S3](../esp32cam/README.md)**.
+
+## Verstehen
+
+| Kapitel | worum es geht |
+|---|---|
+| **[Wie die Erkennung funktioniert](erkennung.md)** | drei Stufen, der Kniff mit dem Artenfilter, was das Modell nicht kann |
+| **[Wie gut ist das wirklich](genauigkeit.md)** | gemessene Zahlen — und was im Feld tatsächlich passiert ist |
+
+## Betreiben
+
+| Kapitel | worum es geht |
+|---|---|
+| **[Betrieb](betrieb.md)** | mehrere Kameras, Live-Bild, Detector auf eigenem Host, Deployment |
+| **[Coolify-Deployment](../deploy/COOLIFY.md)** | der ganze Weg inklusive Datenumzug |
+
+## Mitarbeiten
+
+| Kapitel | worum es geht |
+|---|---|
+| **[Entwicklung](entwicklung.md)** | Tests, Übersetzungen, Layoutprüfung, Artenkatalog erweitern |
+| **[Datenquellen und Lizenzen](datenquellen.md)** | woher Modelle und Fotos kommen, und warum AGPL |
+| **[CONTRIBUTING](../CONTRIBUTING.md)** | Spielregeln und Rechteeinräumung |
+
+---
+
+<sub>Die Bilder in diesem Ordner sind Aufnahmen der Live-Instanz
+<https://vogelalbum.gaertner.onl>, erzeugt mit Playwright. Nach einer Änderung an
+der Oberfläche gehören sie neu gemacht — alte Screenshots sind das Erste, was
+einem Besucher auffällt.</sub>