mirror of
https://github.com/syncthing/syncthing-android.git
synced 2024-12-23 11:21:29 +00:00
44 lines
2.3 KiB
Markdown
44 lines
2.3 KiB
Markdown
# syncthing-android
|
|
|
|
[](https://travis-ci.org/syncthing/syncthing-android)
|
|
[](https://opensource.org/licenses/MPL-2.0)
|
|
[](https://www.bountysource.com/teams/syncthing-android)
|
|
|
|
A wrapper of [Syncthing](https://github.com/syncthing/syncthing) for Android.
|
|
|
|
<img src="app/src/main/play/en-GB/listing/phoneScreenshots/screenshot_phone_1.png" alt="screenshot 1" width="200" /> <img src="app/src/main/play/en-GB/listing/phoneScreenshots/screenshot_phone_2.png" alt="screenshot 2" width="200" /> <img src="app/src/main/play/en-GB/listing/phoneScreenshots/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/).
|
|
|
|
# Building
|
|
|
|
### Dependencies
|
|
- Android SDK (you can skip this if you are using Android Studio)
|
|
- Android NDK (`$ANDROID_NDK_HOME` should point at the root directory of your NDK)
|
|
- Go (see [here](https://docs.syncthing.net/dev/building.html#prerequisites) for the required version)
|
|
|
|
### 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 `./syncthing/build-syncthing.bash`. Then use `./gradlew assembleDebug` or
|
|
Android Studio to build the apk.
|
|
|
|
### Building on Windows
|
|
|
|
To build the Syncthing app on Windows we need to have cygwin installed.
|
|
|
|
From a cygwin shell in the project directory, build Syncthing using `./syncthing/build-syncthing.bash`
|
|
|
|
Lastly, use `./gradlew assembleDebug` in the project directory to compile the APK, or use Android
|
|
Studio to build/deploy the APK.
|
|
|
|
# License
|
|
|
|
The project is licensed under the [MPLv2](LICENSE).
|