Skip to content

Latest commit

 

History

History
81 lines (60 loc) · 3.5 KB

README.md

File metadata and controls

81 lines (60 loc) · 3.5 KB

UnoSim-Dokumentation

Die hier verlinkten Dokumente beschreiben die unterstützte aktuelle Architektur. Weitere Dateien in diesem Verzeichnis sind als historisch oder nicht normativ gekennzeichnet (Kopfzeile); sie dokumentieren Analysen, Pläne und Messläufe, keinen Vertrag.

Nutzung

  • USER_GUIDE.md – UnoSim im Browser bedienen: Sketches, Simulation, Beispiele und Tutor.
  • UnoSim-Examples – eigene Beispiele und Tutor-Inhalte erstellen.

Installation und Betrieb

Für einen ersten Klassenraum-Aufbau ist INSTALL_UBUNTU_VBOX.md der kürzeste Weg; für einen eigenen Reverse Proxy gilt INSTALL_SERVER.md.

  • INSTALL_LOCAL.md – lokale Entwicklung mit lokaler Kompilierung und Simulation.
  • INSTALL_SERVER.md – Docker-Deployment mit erforderlichem Gateway, optionaler Benutzeranmeldung und Docker-Sandboxen.
  • INSTALL_UBUNTU_VBOX.md – Ubuntu-Desktop-Setup in VirtualBox mit Docker, Nginx, TLS und optionaler Benutzeranmeldung.
  • SECURITY.md – Sicherheits- und Isolationsvertrag.
  • RELEASE_RUNBOOK.md – Release-Gates und Betriebskontrollen.

Architektur, APIs und Tests

Kapazität

Entscheidungen und Fachverträge

  • adr/ – akzeptierte Architekturentscheidungen.
  • ../ssot/ – fachliche Single Sources of Truth für UI und Verhalten.

Bei Änderungen zuerst die zuständige normative Quelle aktualisieren.

Offene Punkte (nicht normativ)

  • OPEN_POINTS.md – geprüfte offene Entscheidungen und zurückgestellte Punkte.

Archiv

Erledigte Implementierungspläne werden gelöscht, nicht archiviert; sie bleiben in der Git-Historie.

Namenskonvention

Dateien im Wurzelverzeichnis heißen THEMA_INHALT.md in Großbuchstaben. Das Präfix gruppiert zusammengehörige Dokumente (INSTALL_, CAPACITY_). ADRs liegen unter adr/ als NNNN-titel.md. Fachliche SSOTs unter ../ssot/ heißen ssot_function_definition_<Thema>.md mit <Thema> in PascalCase; nur die Agenten-Policy heißt ssot_agent_policy.md.