Update Tella Android Readme #490
+14
−4
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -79,7 +79,17 @@ Tella for Android can be downloaded: | |
| - from [this folder](https://web.tresorit.com/l/JgMjK#FV9IoIZdDxwAUPqtupJzsQ) or from our [Telegram channel](https://t.me/tellaapp), as an APK, to be installed manually. | ||
|
|
||
| ### Tella FOSS (F-droid) | ||
| We also maintain a version of Tella in the [F-droid store](https://f-droid.org/en/packages/org.hzontal.tellaFOSS/) (`org.hzontal.tellaFOSS`). It is built from **this repository** using the `fdroid` product flavor (see below). The former [Tella-Android-FOSS](https://github.com/Horizontal-org/Tella-Android-FOSS) codebase has been merged here. | ||
|
|
||
| ### Play Store vs F-Droid (build flavors) | ||
| Both the Play Store app and Tella FOSS share one codebase. Two **`distribution`** flavors in `mobile/build.gradle`: | ||
|
|
||
| | Flavor | Application id | Notes | | ||
| |--------|----------------|-------| | ||
| | **`playstore`** | `org.hzontal.tella` | Google Play build; includes Firebase Crashlytics, Google Drive, Dropbox, and Google sign-in | | ||
| | **`fdroid`** | `org.hzontal.tellaFOSS` | F-Droid / Tella FOSS; excludes proprietary Google and Dropbox SDKs | | ||
|
|
||
| F-Droid release builds pass `-Pfdroid` (see `fastlane/README.md` and `docs/fdroid-release-verification.md`). | ||
|
|
||
|
Contributor
There was a problem hiding this comment. can you please add a line saying that details about features available in each of the versions can be found here ? https://tella-app.org/features |
||
|
|
||
| ### Get started on Tella Android | ||
|
|
@@ -92,7 +102,7 @@ This software uses the following open source packages: | |
| - [SQLCipher](https://github.com/sqlcipher/sqlcipher) for our encrypted database. | ||
| - [CacheWord](https://guardianproject.info/code/cacheword/) for passphrase caching and management. | ||
| - [ODK JavaRosa](https://github.com/getodk/javarosa) to work with XForms. | ||
| - [CameraX](https://developer.android.com/jetpack/androidx/releases/camera), [ExoPlayer](https://github.com/google/ExoPlayer), [RxJava](https://github.com/ReactiveX/RxJava), [OkHttp](https://github.com/square/okhttp), [Retrofit](https://github.com/square/retrofit), [Glide](https://github.com/bumptech/glide), [Hilt](https://dagger.dev/hilt/), [Ktor](https://ktor.io/), [WorkManager](https://developer.android.com/jetpack/androidx/releases/work), [Mapsforge](https://github.com/mapsforge/mapsforge), [Nextcloud Android library](https://github.com/nextcloud/android), [PermissionDispatcher](https://github.com/permissions-dispatcher/PermissionsDispatcher), [PatternLock](https://github.com/zhanghai/PatternLock) (vendored in `tella-locking-ui`), and other libraries listed in [mobile/build.gradle](mobile/build.gradle). | ||
|
|
||
| ## Contributing to the code <a id="contributing"></a> | ||
|
|
||
|
|
@@ -109,14 +119,14 @@ This software uses the following open source packages: | |
| **Step 6: Pushing your branch and creating a pull request** Push your branch up and create a pull request. Please indicate which issue your PR addresses in the title. | ||
|
|
||
| ## Translating the app <a id="translating"></a> | ||
| Tella is currently available in [more than 25 languages](https://tella-app.org/translating-tella). We are always looking to translate Tella into more languages. | ||
|
|
||
| If you are interested in adding a new language, or if you noticed a mistake or a missing translation, you can join [follow our contributing guidelines](https://tella-app.org/translating-tella/#how-do-i-become-a-translator). | ||
|
|
||
| ## Contact us <a id="contact"></a> | ||
| We love hearing from users, designers, and developers! | ||
|
|
||
| We offer different ways to [contact us](https://tella-app.org/contact-us). | ||
|
|
||
| If you have any question, ideas or suggestions on how we can improve or what new features we should add, or if you need support deploying Tella, don't hesitate to reach out! | ||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
in the documentation, app (in the version section) and release notes we call these versions "Tella Android" and "Tella Android FOSS". Because some people might use the "playstore" flavor but not from the play store (for example from direct apk download).
In this table maybe is ok (if that's how the flavors are called in the code), but can we plase update the sentence above with the names we use? and maybe add a new column in the table with the name ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ahlem-jarrar