updated letro README

2026-05-03 14:41:42 +03:30
parent 19d9467ea5
commit 419b4f009a
1 changed files with 65 additions and 90 deletions
--- a/README.md
+++ b/README.md
@@ -1,114 +1,89 @@
-[![Latest build](https://github.com/element-hq/element-x-android/actions/workflows/build.yml/badge.svg?query=branch%3Adevelop)](https://github.com/element-hq/element-x-android/actions/workflows/build.yml?query=branch%3Adevelop)
-[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=element-x-android&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=element-x-android)
-[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=element-x-android&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=element-x-android)
-[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=element-x-android&metric=bugs)](https://sonarcloud.io/summary/new_code?id=element-x-android)
-[![codecov](https://codecov.io/github/element-hq/element-x-android/branch/develop/graph/badge.svg?token=ecwvia7amV)](https://codecov.io/github/element-hq/element-x-android)
-[![Element X Android Matrix room #element-x-android:matrix.org](https://img.shields.io/matrix/element-x-android:matrix.org.svg?label=%23element-x-android:matrix.org&logo=matrix&server_fqdn=matrix.org)](https://matrix.to/#/#element-x-android:matrix.org)
-[![Localazy](https://img.shields.io/endpoint?url=https%3A%2F%2Fconnect.localazy.com%2Fstatus%2Felement%2Fdata%3Fcontent%3Dall%26title%3Dlocalazy%26logo%3Dtrue)](https://localazy.com/p/element)
+# Letro Android

-# Element X Android
+Letro Android is a modified version of
+[Element X Android](https://github.com/element-hq/element-x-android),
+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 the Google Play Store
+under the name "Letro".

-Element X Android is the next-generation [Matrix](https://matrix.org/) client provided by [Element](https://element.io/).
+This repository is published as the corresponding source for the
+Letro Android binary, in compliance with the GNU Affero General
+Public License, version 3 (AGPLv3) §6.

-Compared to the previous-generation [Element Classic](https://github.com/element-hq/element-android), the application is a total rewrite, using the [Matrix Rust SDK](https://github.com/matrix-org/matrix-rust-sdk) underneath and targeting devices running Android 7+. The UI layer is written using [Jetpack Compose](https://developer.android.com/jetpack/compose), and the navigation is managed using [Appyx](https://github.com/bumble-tech/appyx).
+## Relationship to upstream

-[<img src="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png" alt="Get it on Google Play" height="80">](https://play.google.com/store/apps/details?id=io.element.android.x)[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" alt="Get it on F-Droid" height="80">](https://f-droid.org/packages/io.element.android.x)
+- Upstream project: <https://github.com/element-hq/element-x-android>
+- 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)

-## Table of contents
-
-<!--- TOC -->
-
-* [Screenshots](#screenshots)
-* [Translations](#translations)
-* [Rust SDK](#rust-sdk)
-* [Status](#status)
-* [Minimum SDK version](#minimum-sdk-version)
-* [Contributing](#contributing)
-* [Build instructions](#build-instructions)
-* [Support](#support)
-* [Copyright and License](#copyright-and-license)
-
-<!--- END -->
-
-## Screenshots
-
-Here are some screenshots of the application:
-
-<!--
-Commands run before taking the screenshots:
-adb shell settings put system time_12_24 24
-adb shell am broadcast -a com.android.systemui.demo -e command enter
-adb shell am broadcast -a com.android.systemui.demo -e command clock -e hhmm 1337
-adb shell am broadcast -a com.android.systemui.demo -e command network -e mobile show -e level 4
-adb shell am broadcast -a com.android.systemui.demo -e command network -e wifi show -e level 4
-adb shell am broadcast -a com.android.systemui.demo -e command notifications -e visible false
-adb shell am broadcast -a com.android.systemui.demo -e command battery -e plugged false -e level 100
-
-And to exit demo mode:
-adb shell am broadcast -a com.android.systemui.demo -e command exit
-->
-
-|<img src="./docs/images-lfs/screen_1_light.png" width="280" />|<img src="./docs/images-lfs/screen_2_light.png" width="280" />|<img src="./docs/images-lfs/screen_3_light.png" width="280" />|<img src="./docs/images-lfs/screen_4_light.png" width="280" />|
-|-|-|-|-|
-|<img src="./docs/images-lfs/screen_1_dark.png" width="280" />|<img src="./docs/images-lfs/screen_2_dark.png" width="280" />|<img src="./docs/images-lfs/screen_3_dark.png" width="280" />|<img src="./docs/images-lfs/screen_4_dark.png" width="280" />|
-
-## Translations
-
-Element X Android supports many languages. You can help us to translate the app in your language by joining our [Localazy project](https://localazy.com/p/element). You can also help us to improve the existing translations.
-
-Note that for now, we keep control on the French and German translations.
-
-Translations can be checked screen per screen using our tool Element X Android Gallery, available at https://element-hq.github.io/element-x-android/. Note that this page is updated every Tuesday.
-
-More instructions about translating the application can be found at [CONTRIBUTING.md](CONTRIBUTING.md#strings).
-
-## Rust SDK
-
-Element X leverages the [Matrix Rust SDK](https://github.com/matrix-org/matrix-rust-sdk) through an FFI layer that the final client can directly import and use.
-
-We're doing this as a way to share code between platforms and while we've seen promising results it's still in the experimental stage and bound to change.
+Upstream technical documentation — build instructions, contributor
+setup, architecture notes — applies unchanged. See the upstream
+[README](https://github.com/element-hq/element-x-android#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 Android
+app. Issues and bug reports specific to the Letro fork should be
+filed here; issues that reproduce against upstream Element X Android
+belong upstream.

-## Minimum SDK version
+## Copyright

-Element X Android requires a minimum SDK version of 24 (Android 7.0, Nougat). We aim to support devices running Android 7.0 and above, which covers a wide range of devices still in use today.
+```
+Copyright (c) 2026 Letro Tech GmbH <legal@letro.com>  -- modifications
+```

-Element Android Enterprise requires a minimum SDK version of 33 (Android 13, Tiramisu). For Element Enterprise, we support only devices that still receive security updates, which means devices running Android 13 and above. Android does not have a documented support policy, but some information can be found at [https://endoflife.date/android](https://endoflife.date/android).
+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).

-## Contributing
+## License

-Want to get actively involved in the project? You're more than welcome! A good way to start is to check the issues that are labelled with the [good first issue](https://github.com/element-hq/element-x-android/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) label. Let us know by commenting the issue that you're starting working on it.
+This software is dual-licensed by Element Creations Ltd. ("Element"):

-But first make sure to read our [contribution guide](CONTRIBUTING.md) first.
+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.

-You can also come chat with the community in the Matrix [room](https://matrix.to/#/#element-x-android:matrix.org) dedicated to the project.
+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.

-## Build instructions
+## Third-party components

-Just clone the project and open it in Android Studio. Make sure to select the
-`app` configuration when building (as we also have sample apps in the project).
+Letro Android bundles third-party components under their own
+licences, including the Matrix Rust SDK (Apache-2.0), Compound Design
+Tokens (AGPLv3), and the further Gradle / Maven dependencies resolved
+in the build. A consolidated attribution list is published at
+[`THIRD_PARTY_LICENSES.md`](THIRD_PARTY_LICENSES.md) and mirrored
+in-app under Settings → About → Acknowledgements.

-To build against a local copy of the Rust SDK, see the [Developer
-onboarding](docs/_developer_onboarding.md#building-the-sdk-locally) instructions.
+## Trademarks

-## Support
+"Matrix" is a trademark of The Matrix.org Foundation C.I.C.

-When you are experiencing an issue on Element X Android, please first search in [GitHub issues](https://github.com/element-hq/element-x-android/issues)
-and then in [#element-x-android:matrix.org](https://matrix.to/#/#element-x-android:matrix.org).
-If after your research you still have a question, ask at [#element-x-android:matrix.org](https://matrix.to/#/#element-x-android: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 from the application settings. This is especially recommended when you encounter a crash.
+"Element" and "Element X" are trademarks of Element Creations Ltd. /
+New Vector Ltd.

-## Copyright and License
+"Google", "Google Play" and "Android" are trademarks of Google LLC.

-Copyright (c) 2025 Element Creations Ltd.
-Copyright (c) 2022 - 2025 New Vector Ltd.
+Letro is **not** affiliated with, endorsed by, or sponsored by The
+Matrix.org Foundation, Element, or Google LLC. 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.

-This software is dual licensed by Element Creations Ltd (Element). It can be used either:
+## Contact

-(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
-
-(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).
-
-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.
+Legal / licensing questions: <legal@letro.com>
+Operating entity / imprint: see <https://www.letro.com/imprint>