1
0
Fork 0
mirror of https://github.com/syncthing/syncthing-android.git synced 2024-11-29 15:51:17 +00:00
syncthing-android/README.md
Catfriend1 73775a116d
Improve building wrapper and native binaries on Windows and Linux
* Do not ask for root if root is disabled in settings
* Show error in UI when libSyncthing.so is missing
* build-syncthing - Install Go on demand on windows
* build-syncthing - Install Android NDK on demand on windows
* Update README.md
* Update APK version to 0.14.51.rc3.6 / 4162
2018-09-22 18:31:36 +02:00

3 KiB

Fork of Syncthing-Android:

License: MPLv2

Major enhancements in this fork are:

  • UI explains why syncthing is running or not running according to the run conditions set in preferences.
  • A welcome wizard guiding you through initial setup on first launch or if mandatory prerequisites are missing like for example the storage permission.
  • Run condition bugs are fixed.
  • "Battery eater" problem is fixed.
  • Android 8+ support is on it's way.
  • Many bug fixes, enhancements and more frequent releases.

A wrapper of Syncthing for Android. Head to the "releases" section for builds. Please open an issue under this fork if you need help. Important: Please don't file bugs at the upstream repository "syncthing-android" if you are using this fork.

screenshot 1 screenshot 2 screenshot 3

Translations

The project is translated on Transifex.

Building

Prerequisites

  • Android SDK You can skip this if you are using Android Studio.
  • Android NDK r16b $ANDROID_NDK_HOME environment variable should point at the root directory of your NDK. If the variable is not set, build-syncthing.py will automatically try to download and setup the NDK.
  • Go 1.9.7 Make sure, Go is installed and available on the PATH environment variable. If Go is not found on the PATH environment variable, build-syncthing.py will automatically try to download and setup GO on the PATH.
  • Python 2.7 Make sure, Python is installed and available on the PATH environment variable.

Build instructions

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

A Linux VM, for example running Debian, is recommended to build this.

Build Syncthing and the Syncthing-Android wrapper using the following commands: ./gradlew buildNative ./gradlew lint assembleDebug

You can also use Android Studio to build the apk after you manually ran the ./gradlew buildNative command in the repository root.

To clean up all files generated during build, use the following commands: ./gradlew cleanNative ./gradlew clean

License

The project is licensed under the MPLv2.