MESSENGER-5734 SweT kompatible Readme

This commit is contained in:
Frank Rotermund
2024-03-01 08:13:23 +01:00
parent 9e79bd7a67
commit c4614dfd1d

View File

@@ -20,7 +20,7 @@ Fangen wir mit dem Wichtigsten an. Hier findest Du die offizielle App für iOS:
Wenn Dir die App gefällt, lass gerne eine positive Bewertung da.
BundesMessenger-iOS ist ein iOS Matrix Client basierend auf [Element iOS](https://github.com/vector-im/element-ios)
BundesMessenger-iOS ist ein iOS Matrix Client basierend auf [Element iOS](https://github.com/element-hq/element-ios)
von [Element Software](https://element.io/).
Allgemeine Infos zum Thema BundesMessenger und was dahinter steckt findet ihr [hier](https://gitlab.opencode.de/bwi/bundesmessenger/info).
@@ -36,7 +36,7 @@ Hierzu durchlaufen wir folgenden Prozess:
<img src="docs/img/element-bum-bwm.png" width="600">
</p>
Aufgrund der starken Bindung an *Element iOS* ist es aktuell nicht vorgesehen, dass ihr über das Repository Einfluss auf den BundesMessenger nehmen könnt. Wenn ihr euch beteiligen wollt, müsst ihr eure Contribution direkt in [Element iOS](https://github.com/vector-im/element-ios) einfließen lassen. Diese werden in der Regel im Anschluss in den BundesMessenger übernommen.
Aufgrund der starken Bindung an *Element iOS* ist es aktuell nicht vorgesehen, dass ihr über das Repository Einfluss auf den BundesMessenger nehmen könnt. Wenn ihr euch beteiligen wollt, müsst ihr eure Contribution direkt in [Element iOS](https://github.com/element-hq/element-ios) einfließen lassen. Diese werden in der Regel im Anschluss in den BundesMessenger übernommen.
Wenn ihr euch unsicher seid, haltet hierzu gerne [Rücksprache mit uns](#kontakt).
@@ -48,6 +48,35 @@ Wir möchten 100% transparent sein und euch die Möglichkeit geben den Source Co
Wir freuen uns über euer Feedback. Öffnet gerne neue Issues für eure Fragen oder Probleme hier im GitLab.
## Repo
https://gitlab.opencode.de/bwi/bundesmessenger/clients/bundesmessenger-ios
## Fehler und Verbesserungsvorschläge
https://gitlab.opencode.de/bwi/bundesmessenger/clients/bundesmessenger-ios/-/issues
## Abhängigkeiten
[Element iOS](https://github.com/element-hq/element-iOS)
[BundesMessenger iOS Matrix SDK](https://gitlab.opencode.de/bwi/bundesmessenger/clients/bundesmessenger-ios-matrix-sdk)
## Für Entwickler
Weiterführende Dokumentation zum Projekt, dem Betrieb und der Architektur findest Du [hier](https://gitlab.opencode.de/bwi/bundesmessenger/info).
Nachdem das Projekt ausgecheckt ist, reichen folgende Anweisungen zum Compilat und zum Start der App
```
$ bundle install # Installiert Abhängigkeiten falls notwendig
$ xcodegen # Erzeugt das xcodeproj mit allen Quellcodedateien
$ pod install # Erzeugt den xcworkspace mit allen Projektabhängigkeiten
$ Öffne Riot.xcworkspace # Öffnet Xcode
$ Stelle das target auf BuM-Beta oder BundesMessenger
```
## Updates
In der Regel werden wir hier alle 4 Wochen ein Update veröffentlichen. In etwa zeitgleich erfolgt das Update der Apps in den App Stores.