update README.md for opencode

This commit is contained in:
Jürgen Wischer
2022-12-05 22:31:13 +01:00
parent 6773b0a438
commit dc006f5146
2 changed files with 77 additions and 39 deletions

116
README.md
View File

@@ -1,60 +1,98 @@
# Element iOS
<div align="center">
<img src="https://gitlab.opencode.de/bwi/bundesmessenger/info/-/raw/main/images/logo.png?inline=false" alt="BundesMessenger Logo" width="128" height="128">
</div>
![GitHub release (latest by date)](https://img.shields.io/github/v/release/vector-im/element-ios)
![badge-languages](https://img.shields.io/badge/languages-Swift%20%7C%20ObjC-orange.svg)
[![Swift 5.x](https://img.shields.io/badge/Swift-5.x-orange)](https://developer.apple.com/swift)
[![Build status](https://badge.buildkite.com/cc8f93e32da93fa7c1172398bd8af66254490567c7195a5f3f.svg?branch=develop)](https://buildkite.com/matrix-dot-org/element-ios/builds?branch=develop)
[![Weblate](https://translate.riot.im/widgets/riot-ios/-/svg-badge.svg)](https://translate.riot.im/engage/riot-ios/?utm_source=widget)
[![codecov](https://codecov.io/gh/vector-im/element-ios/branch/develop/graph/badge.svg?token=INNm5o6XWg)](https://codecov.io/gh/vector-im/element-ios)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=vector-im_element-ios&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=vector-im_element-ios)
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=vector-im_element-ios&metric=bugs)](https://sonarcloud.io/summary/new_code?id=vector-im_element-ios)
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=vector-im_element-ios&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=vector-im_element-ios)
[![Element iOS Matrix room #element-ios:matrix.org](https://img.shields.io/matrix/element-ios:matrix.org.svg?label=%23element-ios:matrix.org&logo=matrix&server_fqdn=matrix.org)](https://matrix.to/#/#element-ios:matrix.org)
![GitHub](https://img.shields.io/github/license/vector-im/element-ios)
[![Twitter URL](https://img.shields.io/twitter/url?label=Element&url=https%3A%2F%2Ftwitter.com%2Felement_hq)](https://twitter.com/element_hq)
<div align="center">
<h2 align="center">BundesMessenger-iOS</h2>
</div>
Element iOS is an iOS [Matrix](https://matrix.org/) client provided by [Element](https://element.io/). It is based on [MatrixSDK](https://github.com/matrix-org/matrix-ios-sdk).
----
Wir freuen uns, dass Du Dich für den BundesMessenger interessierst.
Fangen wir mit dem Wichtigsten an. Hier findest Du die offizielle App für iOS:
<p align="center">
<a href=https://itunes.apple.com/us/app/element/id1083446067?mt=8>
<img alt="Download on the app store" src="https://linkmaker.itunes.apple.com/images/badges/en-us/badge_appstore-lrg.svg" width=160>
<a href=https://apps.apple.com/us/app/bundesmessenger/id1616866351>
<img alt="Download Apple App Store" src="https://linkmaker.itunes.apple.com/images/badges/en-us/badge_appstore-lrg.svg" width=160>
</a>
</p>
## Beta testing
Wenn Dir die App gefällt, lass gerne eine positive Bewertung da.
You can try last beta build by accessing our [TestFlight Public Link](https://testflight.apple.com/join/lCeTuDKM). For questions and feedback about latest TestFlight build, please access the Element iOS Matrix room: [#element-ios:matrix.org](https://matrix.to/#/#element-ios:matrix.org).
BundesMessenger-iOS ist ein iOS Matrix Client basierend auf [Element iOS](https://github.com/vector-im/element-ios)
von [Element Software](https://element.io/).
## Build instructions
Allgemeine Infos zum Thema BundesMessenger und was dahinter steckt findet ihr [hier](https://gitlab.opencode.de/bwi/bundesmessenger/info).
If you have already everything installed, opening the project workspace in Xcode should be as easy as:
```
$ xcodegen # Create the xcodeproj with all project source files
$ pod install # Create the xcworkspace with all project dependencies
$ open Riot.xcworkspace # Open Xcode
```
## Grundsätzliches
Else, you can visit our [installation guide](./INSTALL.md). This guide also offers more details and advanced usage like using [MatrixSDK](https://github.com/matrix-org/matrix-ios-sdk) in its development version.
BundesMessenger ist ein Artefakt, welches durch die BWI im Herstellungsprozess für den BwMessenger alle 4 Wochen hergestellt wird.
## Contributing
Hierzu durchlaufen wir folgenden Prozess:
If you want to contribute to Element iOS code or translations, go to the [contribution guide](CONTRIBUTING.md).
<p align="center">
<img src="docs/img/element-bum-bwm.png" width="600">
</p>
## Support
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.
When you are experiencing an issue on Element iOS, please first search in [GitHub issues](https://github.com/vector-im/element-ios/issues)
and then in [#element-ios:matrix.org](https://matrix.to/#/#element-ios:matrix.org).
If after your research you still have a question, ask at [#element-ios:matrix.org](https://matrix.to/#/#element-ios:matrix.org). Otherwise feel free to create a GitHub issue if you encounter a bug or a crash, by explaining clearly in detail what happened. You can also perform bug reporting (Rageshake) from the Element application by shaking your phone or going to the application settings. This is especially recommended when you encounter a crash.
Wenn ihr euch unsicher seid, haltet hierzu gerne [Rücksprache mit uns](#kontakt).
## Copyright & License
> Übrigens: Diesen Prozess leben wir selber auch für bestimmte Features.
Copyright (c) 2014-2017 OpenMarket Ltd
Copyright (c) 2017 Vector Creations Ltd
Copyright (c) 2017-2021 New Vector Ltd
**Warum veröffentlichen wir hier den Quellcode?**
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the [LICENSE](LICENSE) file, or at:
Wir möchten 100% transparent sein und euch die Möglichkeit geben den Source Code einzusehen.
[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
Wir freuen uns über euer Feedback. Öffnet gerne neue Issues für eure Fragen oder Probleme hier im GitLab.
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
## 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.
Sollte es zu Sicherheitsvorfällen kommen, stellen wir hier und im App Store auch kurzfristig Hotfixes zur Verfügung.
## Forks
Du hast die Möglichkeit einen Fork von diesem Projekt zu machen. Bitte beachte, dass die [kontinuierliche Pflege](#updates) sehr viel Aufwand und Entwicklungsressourcen benötigt.
Wir nehmen euch diese Arbeit ab, da wir dies für den BwMessenger ohnehin machen müssen. Daher empfehlen wir euch für den produktiven Einsatz in der öffentlichen Verwaltung die gepflegten BundesMessenger Apps aus den App Stores zu verwenden. Ziel ist es nicht euch auszuschließen, sondern eine stetige hohe Qualität und Sicherheit zur Verfügung zu stellen.
| :warning: Wichtig: Dieses Repository ist ein Mirror eines internen BWI Repos. Die aktive Entwicklung findet nicht in diesem Repository statt. Es müssen BWI spezifische Build Anteile entfernt werden (z.B. GitLab CI Informationen). Um dies zu gewährleisten wird die Git History beim Mirroring neu geschrieben. Wenn ihr einen Fork von diesem Repository erstellt, müsst ihr mit erhöhten Aufwänden bei Updates rechnen. |
| --- |
## Nutzung
Um die BundesMessenger App aus dem Play Store nutzen zu können, muss ihr euer Backend registrieren lassen. Weitere Infos dazu [hier](https://messenger.bwi.de/ich-will-bum).
Wenn Du Dein Backend noch nicht erfolgreich aufgebaut hast, aber trotzdem schon einen Blick in die App werfen möchtest, bieten wir Dir eine Demo Umgebung an. Bitte kontaktiere uns per [Email](mailto:bundesmessenger@bwi.de&subject=Ich%20will%20testen).
## Rechtliches
**BundesMessenger** ist sowohl als Logo- und als Textmarke durch die [BWI GmbH](https://www.bwi.de) geschützt.
Eine Nutzung derselben ist nur mit Freigabe durch die BWI möglich.
| :warning: Wichtig: Falls ihr einen Fork erstellt, müssen alle Verweise (Texte & Bilder) auf BundesMessenger und die BWI zwingend entfernt werden! |
| --- |
Die Lizenz des BundesMessenger iOS ist die [Apache 2.0](./LICENSE).
### Copyright
- [BWI GmbH](https://messenger.bwi.de/copyright)
- [Element](https://element.io/copyright)
## Kontakt
Für den Austausch zum BundesMessenger haben wir einen [Matrix Raum](https://matrix.to/#/#opencodebum:matrix.org) erstellt.
<div align="center">
<img src="https://gitlab.opencode.de/bwi/bundesmessenger/info/-/raw/main/images/qr_matrix_room.png" alt="QR Code Matrix" width="128" height="128"/>
</div>
Kein Matrix Client zur Hand, dann auch gerne über unser [Email Postfach](mailto:bundesmessenger@bwi.de).
Wir freuen uns auf den Austausch.

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB