„README.md“ ändern

README.md

@@ -1,2 +1,55 @@
-# meincantor-app
+# MeinCantor-App [ALPHA]
-The UI for the GCG.MeinCantor school platform made with Flutter in Dart.
+
+[![Google Play Store]()]()
+[![Apple App Store]()]()
+[![F-Droid]()]()
+
+MeinCantor ist eine freie Schulplattform, welche vom [Georg-Cantor-Gymnasium](https://cantorgymnasium.de) entwickelt wurde.
+
+Die Plattform ist dazu da, sowohl Schüler\*innen als auch Lehrer\*innen möglichst viele Dienste innerhalb von einer OpenSource-App anzubieten und dafür auf mehrere, z. T. proprietäre Client-Anwendungen zu verzichten.
+
+MeinCantor enthält integrationen für folgende Dienste:
+- Vertretungsplan:
+    - Indiware (ALPHA)
+    - PostgreSQL direct (WIP)
+- Schulbibliothek:
+    - Koha (WIP)
+- Schülerzeitung:
+    - Strapi (WIP)
+- Raumübersicht:
+    - OSM indoor mapping (WIP)
+- Alerts:
+    - Strapi (WIP)
+- Authentifizierung:
+    - Keycloak (ALPHA)
+    - OpeinID Connect (WIP)
+- Chat:
+    - Rocket.Chat (WIP)
+    - Matrix (WIP)
+
+## APK Bauen
+
+1. Flutter installieren: https://flutter.dev/docs/get-started/install
+
+2.
+
+'''bash
+git clone https://git.cantorgymnasium.de/cantortechnik/meincantor-app
+###
+cd meincantor-app
+###
+flutter build apk
+
+## Für andere Schulen benutzen
+
+Um MeinCantor für eine andere Schule einzurichten, folgen Sie der [Anleitung]()
+
+## Copyright
+
+Copyright © 2021 Denys Konovalov, Georg-Cantor-Gymnasium Halle(Saale)
+
+Dieses Programm ist freie Software. Sie können es unter den Bedingungen der GNU Affero General Public License, wie von der Free Software Foundation veröffentlicht, weitergeben und/oder modifizieren, entweder gemäß Version 3 der Lizenz oder jeder späteren Version.
+
+Die Veröffentlichung dieses Programms erfolgt in der Hoffnung, daß es Ihnen von Nutzen sein wird, aber OHNE IRGENDEINE GARANTIE, sogar ohne die implizite Garantie der MARKTREIFE oder der VERWENDBARKEIT FÜR EINEN BESTIMMTEN ZWECK. Details finden Sie in der GNU General Public License.
+
+Sie sollten ein Exemplar der GNU Affero General Public License zusammen mit diesem Programm erhalten haben. Falls nicht, siehe <http://www.gnu.org/licenses/>.