upated README.md
This commit is contained in:
Letro Bot
100
README.md
100
README.md
@@ -1,57 +1,89 @@
|
||||
[](https://matrix.to/#/#element-x-ios:matrix.org)
|
||||
|
||||
# Letro iOS
|
||||
|
||||
|
||||
|
||||
Letro iOS is a modified version of [Element X iOS](https://github.com/element-hq/element-x-ios),
|
||||
the next-generation [Matrix](https://matrix.org/) client developed by
|
||||
[Element](https://element.io/) (Element Creations Ltd. / New Vector
|
||||
Ltd.). It is distributed by Letro Tech GmbH via Apple's App Store
|
||||
under the name "Letro".
|
||||
|
||||
[](https://codecov.io/gh/element-hq/element-x-ios)
|
||||
[](https://sonarcloud.io/summary/new_code?id=element-x-ios)
|
||||
[](https://sonarcloud.io/summary/new_code?id=element-x-ios)
|
||||
[](https://sonarcloud.io/summary/new_code?id=element-x-ios)
|
||||
This repository is published as the corresponding source for the
|
||||
Letro iOS binary, in compliance with the GNU Affero General Public
|
||||
License, version 3 (AGPLv3) §6.
|
||||
|
||||
# Element X iOS
|
||||
## Relationship to upstream
|
||||
|
||||
Element X iOS is the next-generation [Matrix](https://matrix.org/) client provided by [Element](https://element.io/).
|
||||
- Upstream project: <https://github.com/element-hq/element-x-ios>
|
||||
- Upstream baseline used by this fork: see
|
||||
[`UPSTREAM_VERSION`](UPSTREAM_VERSION)
|
||||
- Letro modifications, with dates, serving as the AGPLv3 §5(a)
|
||||
modification notice for the work as a whole: see
|
||||
[`FORK_DIVERGENCE.md`](FORK_DIVERGENCE.md)
|
||||
|
||||
Compared to the previous-generation [Element Classic](https://github.com/element-hq/element-ios), it is a total rewrite using the [Matrix Rust SDK](https://github.com/matrix-org/matrix-rust-sdk) underneath and targeting devices running iOS 17+.
|
||||
|
||||
## Rust SDK
|
||||
|
||||
Element X leverages the [Matrix Rust SDK](https://github.com/matrix-org/matrix-rust-sdk) through an FFI layer exposed as a [swift package](https://github.com/matrix-org/matrix-rust-components-swift) that the final client can directly import and use. We're doing this as a way to share code between platforms, with [Element X Android](https://github.com/element-hq/element-x-android) using the same SDK.
|
||||
Upstream technical documentation — build instructions, contributor
|
||||
setup, architecture notes — applies unchanged. See the upstream
|
||||
[README](https://github.com/element-hq/element-x-ios#readme).
|
||||
|
||||
## Status
|
||||
|
||||
This project is actively developed and supported. New users are recommended to use Element X instead of the previous-generation app.
|
||||
This repository tracks the production source for the Letro iOS app.
|
||||
Issues and bug reports specific to the Letro fork should be filed
|
||||
here; issues that reproduce against upstream Element X iOS belong
|
||||
upstream.
|
||||
|
||||
## Contributing
|
||||
## Copyright
|
||||
|
||||
Please see our [contribution guide](CONTRIBUTING.md).
|
||||
```
|
||||
Copyright (c) 2026 Letro Tech GmbH <legal@letro.com> -- modifications
|
||||
```
|
||||
|
||||
Come chat with the community in the dedicated Matrix [room](https://matrix.to/#/#element-x-ios:matrix.org).
|
||||
The upstream copyright lines (Element Creations Ltd., New Vector
|
||||
Ltd., and the other upstream contributors) are preserved verbatim
|
||||
in the source files and in [`LICENSE`](LICENSE), as required by
|
||||
AGPLv3. Letro does not claim authorship of upstream code; the parts
|
||||
modified by Letro are identified in
|
||||
[`FORK_DIVERGENCE.md`](FORK_DIVERGENCE.md).
|
||||
|
||||
## Build instructions
|
||||
## License
|
||||
|
||||
Please refer to the [setting up a development environment](CONTRIBUTING.md#setting-up-a-development-environment) section from the [contribution guide](CONTRIBUTING.md).
|
||||
This software is dual-licensed by Element Creations Ltd. ("Element"):
|
||||
|
||||
## Support
|
||||
1. for free under the GNU Affero General Public License, version 3
|
||||
or (at your option) any later version (AGPLv3); or
|
||||
2. under a paid Element Commercial License agreement between you and
|
||||
Element.
|
||||
|
||||
When you are experiencing an issue on Element X iOS, please first search in [GitHub issues](https://github.com/element-hq/element-x-ios/issues)
|
||||
and then in [#element-x-ios:matrix.org](https://matrix.to/#/#element-x-ios:matrix.org).
|
||||
If after your research you still have a question, ask at [#element-x-ios:matrix.org](https://matrix.to/#/#element-x-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 going to the application settings. This is especially recommended when you encounter a crash.
|
||||
Letro distributes this fork under option (1), AGPLv3. The full
|
||||
licence texts are in [`LICENSE`](LICENSE) and
|
||||
[`LICENSE-COMMERCIAL`](LICENSE-COMMERCIAL). Letro's own modifications
|
||||
are likewise licensed under AGPLv3.
|
||||
|
||||
## Forking
|
||||
## Third-party components
|
||||
|
||||
Please read our [forking guide](docs/FORKING.md).
|
||||
Letro iOS bundles third-party components under their own licences,
|
||||
including the Matrix Rust SDK (Apache-2.0), MapLibre (BSD-2-Clause),
|
||||
Compound Design Tokens (AGPLv3), and the further Swift Package Manager
|
||||
dependencies resolved in `Package.resolved`. A consolidated
|
||||
attribution list is published at
|
||||
[`THIRD_PARTY_LICENSES.md`](THIRD_PARTY_LICENSES.md) and mirrored
|
||||
in-app under Settings → About → Acknowledgements.
|
||||
|
||||
## Copyright & License
|
||||
## Trademarks
|
||||
|
||||
Copyright (c) 2025 Element Creations Ltd.
|
||||
Copyright (c) 2022 - 2025 New Vector Ltd.
|
||||
"Matrix" is a trademark of The Matrix.org Foundation C.I.C.
|
||||
|
||||
This software is dual licensed by Element Creations Ltd (Element). It can be used either:
|
||||
"Element" and "Element X" are trademarks of Element Creations Ltd. /
|
||||
New Vector Ltd.
|
||||
|
||||
(1) for free under the terms of the GNU Affero General Public License (as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version); OR
|
||||
"Apple" and "App Store" are trademarks of Apple Inc.
|
||||
|
||||
(2) under the terms of a paid-for Element Commercial License agreement between you and Element (the terms of which may vary depending on what you and Element have agreed to).
|
||||
Letro is **not** affiliated with, endorsed by, or sponsored by The
|
||||
Matrix.org Foundation, Element, or Apple Inc. References to "Matrix",
|
||||
"Element" and the other names above in this repository's source,
|
||||
documentation, history and configuration are made solely to identify
|
||||
the upstream protocol and the upstream project from which Letro is
|
||||
derived, as permitted by nominative fair use.
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software distributed under the Licenses is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licenses for the specific language governing permissions and limitations under the Licenses.
|
||||
## Contact
|
||||
|
||||
Legal / licensing questions: <legal@letro.com>
|
||||
Operating entity / imprint: see <https://www.letro.com/imprint>
|
||||
Reference in New Issue
Block a user