syncthing-android/README.md

# syncthing-android

[![Build Status](https://travis-ci.org/syncthing/syncthing-android.svg?branch=main)](https://travis-ci.org/syncthing/syncthing-android)
[![License: MPLv2](https://img.shields.io/badge/License-MPLv2-blue.svg)](https://opensource.org/licenses/MPL-2.0)
[![Bountysource](https://api.bountysource.com/badge/tracker?tracker_id=1183310)](https://www.bountysource.com/teams/syncthing-android)

A wrapper of [Syncthing](https://github.com/syncthing/syncthing) for Android.

<img src="app/src/main/play/listings/en-GB/graphics/phone-screenshots/screenshot_phone_1.png" alt="screenshot 1" width="200" /> <img src="app/src/main/play/listings/en-GB/graphics/phone-screenshots/screenshot_phone_2.png" alt="screenshot 2" width="200" /> <img src="app/src/main/play/listings/en-GB/graphics/phone-screenshots/screenshot_phone_3.png" alt="screenshot 3" width="200" />

[<img alt="Get it on Google Play" src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png" height="80">](https://play.google.com/store/apps/details?id=com.nutomic.syncthingandroid) [<img alt="Get it on F-Droid" src="https://f-droid.org/badge/get-it-on.png" height="80">](https://f-droid.org/app/com.nutomic.syncthingandroid)

# Translations

The project is translated on [Transifex](https://www.transifex.com/projects/p/syncthing-android/).

## Dev

Language mappings are defined in `.tx/config`, with the second code being the one from transifex. Google play supported languages: https://support.google.com/googleplay/android-developer/table/4419860. Android supported languages: https://stackoverflow.com/questions/7973023/what-is-the-list-of-supported-languages-locales-on-android. If a new language is added on transifex that's not supported, add them to `deleteUnsupportedPlayTranslations` in `app/build.gradle`.

# Building

### Dependencies
- Android SDK, with `$ANDROID_HOME` pointing to it (you can skip this if you are using Android Studio)
- Android NDK (you should install the required version (`ext.ndkVersionShared` in `./build.gradle`) with the usual tools, such that it's located within `$ANDROID_HOME/ndk/`).
- Go (see [here](https://docs.syncthing.net/dev/building.html#prerequisites) for the required version)
- Java Version 11 (you scan skip this if you are using Android Studio, otherwise you might need to set `$JAVA_HOME` accordingly)

### Build instructions

Make sure you clone the project with
`git clone https://github.com/syncthing/syncthing-android.git --recursive`. Alternatively, run
`git submodule init && git submodule update` in the project folder.

Build Syncthing using `./gradlew buildNative`. Then use `./gradlew assembleDebug` or
Android Studio to build the apk.

# License

The project is licensed under the [MPLv2](LICENSE).
Reformatted README, added Translation instructions. 2014-09-25 10:39:53 +00:00			`# syncthing-android`
Set up cross compile of syncthing to android (arm) and included it in an app. Syncthing does not actually work yet, probably because paths are different. 2014-02-22 17:12:05 +00:00
use main branch for travis build status 2020-07-28 12:11:44 +00:00			`[![Build Status](https://travis-ci.org/syncthing/syncthing-android.svg?branch=main)](https://travis-ci.org/syncthing/syncthing-android)`
Added license badge 2016-10-09 10:30:33 +00:00			`[![License: MPLv2](https://img.shields.io/badge/License-MPLv2-blue.svg)](https://opensource.org/licenses/MPL-2.0)`
Added Bountysource link to readme 2016-12-30 16:53:21 +00:00			`[![Bountysource](https://api.bountysource.com/badge/tracker?tracker_id=1183310)](https://www.bountysource.com/teams/syncthing-android)`
Added tip4commit badge (closes #102). 2014-08-25 15:27:18 +00:00
Updated README 2015-05-05 22:35:25 +00:00			`A wrapper of [Syncthing](https://github.com/syncthing/syncthing) for Android.`
Set up cross compile of syncthing to android (arm) and included it in an app. Syncthing does not actually work yet, probably because paths are different. 2014-02-22 17:12:05 +00:00
Update screenshot locations in readme 2019-06-27 08:51:29 +00:00			`<img src="app/src/main/play/listings/en-GB/graphics/phone-screenshots/screenshot_phone_1.png" alt="screenshot 1" width="200" /> <img src="app/src/main/play/listings/en-GB/graphics/phone-screenshots/screenshot_phone_2.png" alt="screenshot 2" width="200" /> <img src="app/src/main/play/listings/en-GB/graphics/phone-screenshots/screenshot_phone_3.png" alt="screenshot 3" width="200" />`
Added app screenshots to Readme. This isn't perfect, as the images are downscaled in the client, and aren't spaced out nicely. 2014-08-25 23:31:14 +00:00
Update Google Play and F-Droid badges 2016-04-30 05:06:24 +00:00			`[<img alt="Get it on Google Play" src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png" height="80">](https://play.google.com/store/apps/details?id=com.nutomic.syncthingandroid) [<img alt="Get it on F-Droid" src="https://f-droid.org/badge/get-it-on.png" height="80">](https://f-droid.org/app/com.nutomic.syncthingandroid)`
Added Play Store link to README. 2014-05-10 11:40:13 +00:00
Reformatted README, added Translation instructions. 2014-09-25 10:39:53 +00:00			`# Translations`

			`The project is translated on [Transifex](https://www.transifex.com/projects/p/syncthing-android/).`

Remove play unsupported languages and add info about that to readme 2021-07-19 10:26:42 +00:00			`## Dev`

Fixed README.md recognised as binary (#1684) Co-authored-by: Catfriend1 <16361913+Catfriend1@users.noreply.github.com> 2021-09-03 06:46:16 +00:00			Language mappings are defined in `.tx/config`, with the second code being the one from transifex. Google play supported languages: https://support.google.com/googleplay/android-developer/table/4419860. Android supported languages: https://stackoverflow.com/questions/7973023/what-is-the-list-of-supported-languages-locales-on-android. If a new language is added on transifex that's not supported, add them to `deleteUnsupportedPlayTranslations` in `app/build.gradle`.
Remove play unsupported languages and add info about that to readme 2021-07-19 10:26:42 +00:00
Reformatted README, added Translation instructions. 2014-09-25 10:39:53 +00:00			`# Building`

Revert "Revert build script changes" This reverts commit 18c419b2eda9f00cc4fcc1a444af11a864351106. 2017-10-24 05:55:28 +00:00			`### Dependencies`
Set ndk path automatically in gradle (#1741) 2021-12-08 09:55:50 +00:00			- Android SDK, with `$ANDROID_HOME` pointing to it (you can skip this if you are using Android Studio)
			- Android NDK (you should install the required version (`ext.ndkVersionShared` in `./build.gradle`) with the usual tools, such that it's located within `$ANDROID_HOME/ndk/`).
Revert "Revert build script changes" This reverts commit 18c419b2eda9f00cc4fcc1a444af11a864351106. 2017-10-24 05:55:28 +00:00			`- Go (see [here](https://docs.syncthing.net/dev/building.html#prerequisites) for the required version)`
readme: Reference java 11 not 8 2021-07-07 13:42:47 +00:00			- Java Version 11 (you scan skip this if you are using Android Studio, otherwise you might need to set `$JAVA_HOME` accordingly)
Prepare building environment for F-Droid. 2014-08-20 21:58:28 +00:00
Reformatted README, added Translation instructions. 2014-09-25 10:39:53 +00:00			`### Build instructions`
Set up cross compile of syncthing to android (arm) and included it in an app. Syncthing does not actually work yet, probably because paths are different. 2014-02-22 17:12:05 +00:00
Revert "Revert build script changes" This reverts commit 18c419b2eda9f00cc4fcc1a444af11a864351106. 2017-10-24 05:55:28 +00:00			`Make sure you clone the project with`
			`git clone https://github.com/syncthing/syncthing-android.git --recursive`. Alternatively, run
			`git submodule init && git submodule update` in the project folder.
Use hardcoded version names for gradle dependencies. Also added notes in Readme on how to update dependencies and submodules. 2014-08-25 23:51:07 +00:00
Move build script to python (#1184) 2018-07-17 23:17:58 +00:00			Build Syncthing using `./gradlew buildNative`. Then use `./gradlew assembleDebug` or
Revert "Revert build script changes" This reverts commit 18c419b2eda9f00cc4fcc1a444af11a864351106. 2017-10-24 05:55:28 +00:00			`Android Studio to build the apk.`
Prepare building environment for F-Droid. 2014-08-20 21:58:28 +00:00
Reformatted README, added Translation instructions. 2014-09-25 10:39:53 +00:00			`# License`
Added MIT license. 2014-05-05 21:52:51 +00:00
Change license to MPLv2. 2015-03-17 21:27:50 +00:00			`The project is licensed under the [MPLv2](LICENSE).`