From 74d38fd2676f6f112f50883d1fef761115f91611 Mon Sep 17 00:00:00 2001
From: Bernd Steckmeister <bernd.steckmeister@gmail.com>
Date: Fri, 3 Jul 2026 09:45:49 +0200
Subject: [PATCH] docs: README durch echte Projektbeschreibung ersetzen
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Ersetzt das Flutter-Boilerplate-README durch Funktionsübersicht,
Build-Anleitung und Projektstruktur.
---
 CHANGES.md |  1 +
 README.md  | 61 ++++++++++++++++++++++++++++++++++++++++++++----------
 2 files changed, 51 insertions(+), 11 deletions(-)

diff --git a/CHANGES.md b/CHANGES.md
index ead8f7d..fc8c1f1 100644
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -1122,3 +1122,4 @@
 2026-07-03 09:44 [Edit] /home/steggi/pyramid/lib/core/voip_manager.dart
 2026-07-03 09:44 [Edit] /home/steggi/pyramid/lib/widgets/settings_modal.dart
 2026-07-03 09:44 [Edit] /home/steggi/pyramid/lib/widgets/settings_modal.dart
+2026-07-03 09:45 [Write] /home/steggi/pyramid/README.md
diff --git a/README.md b/README.md
index 7529426..685e9a4 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,56 @@
-# pyramid
+# Pyramid
 
-A new Flutter project.
+Pyramid ist ein eigenständiger Matrix-Client (Flutter), kein Fork von FluffyChat
+oder Element. Er läuft gegen den selbst gehosteten Homeserver `steggi-matrix.work`
+(Continuwuity) und ist bei echten Nutzern im Einsatz – Stabilität und
+Datensicherheit haben Vorrang vor Feature-Tempo.
 
-## Getting Started
+## Funktionsumfang
 
-This project is a starting point for a Flutter application.
+- Matrix-Chat mit Timeline, Reply, Medien, Link-Vorschauen, lokaler Volltextsuche
+  über entschlüsselte Nachrichten (server-seitige Suche funktioniert bei E2EE nicht)
+- Ende-zu-Ende-Verschlüsselung (vodozemac/Olm/Megolm) inkl. Key-Backup
+- Sprach-/Video-Calls und Bildschirmübertragung über LiveKit
+  (`wss://livekit.steggi-matrix.work`)
+- Push-Benachrichtigungen mit clientseitiger Entschlüsselung auch bei gekillter
+  App (FCM + Sygnal, siehe `docs/NOTIFICATIONS.md`)
+- Größenverstellbares Panel-Layout (Rooms/Chat/Members) statt starrer Tabs
 
-A few resources to get you started if this is your first Flutter project:
+## Build
 
-- [Learn Flutter](https://docs.flutter.dev/get-started/learn-flutter)
-- [Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
-- [Flutter learning resources](https://docs.flutter.dev/reference/learning-resources)
+Voraussetzung: Flutter (stable channel, siehe `environment.sdk` in `pubspec.yaml`
+für die unterstützte Dart-Version).
 
-For help getting started with Flutter development, view the
-[online documentation](https://docs.flutter.dev/), which offers tutorials,
-samples, guidance on mobile development, and a full API reference.
+```
+flutter pub get
+flutter run -d windows   # schnellster Praxistest während der Entwicklung
+flutter analyze          # muss sauber bleiben
+```
+
+Unterstützte Zielplattformen: Android, Windows, Linux, iOS, macOS (Ordner
+`android/`, `windows/`, `linux/`, `ios/`, `macos/` sind Standard-Flutter-Projekte).
+Release-Build (signiert, Windows + Android): `scripts/release.ps1`.
+
+## Projektstruktur
+
+```
+lib/
+  core/        Matrix-Client, Auth, VoIP-Manager, Storage, App-State
+  features/
+    auth/      Login, Server-Auswahl
+    rooms/     Raumliste, Spaces
+    chat/      Timeline, Composer, Medien, Dokumentenvorschau
+    call/      LiveKit-Calls, Voice-Channel, Mini-Call-Widget
+    members/   Mitgliederliste/-panel
+    settings/  Einstellungen
+  layout/      Panel-Layout (resizable)
+  widgets/     geteilte UI-Bausteine
+  utils/       Hilfsfunktionen
+```
+
+## Weiterführende Dokumentation
+
+- `CLAUDE.md` – Arbeitsregeln und Infrastruktur für die Zusammenarbeit mit Claude
+- `ROADMAP.md` / `PROGRESS.md` – aktueller Stand und nächste Schritte
+- `docs/NOTIFICATIONS.md` – Push-Architektur (native Anzeige vs. Hintergrund-Entschlüsselung)
+- `docs/matrix-sdk/` – Hinweise zum verwendeten Matrix-SDK