syncthing-android/README.md

# Fork of Syncthing-Android:

[![License: MPLv2](https://img.shields.io/badge/License-MPLv2-blue.svg)](https://opensource.org/licenses/MPL-2.0)
<a href="https://github.com/Catfriend1/syncthing-android/releases" alt="GitHub release"><img src="https://img.shields.io/github/release/Catfriend1/syncthing-android/all.svg" /></a>
<a href="https://f-droid.org/de/packages/com.github.catfriend1.syncthingandroid" alt="F-Droid release"><img src="https://img.shields.io/badge/f--droid-4158-brightgreen.svg" /></a>

# 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](https://github.com/syncthing/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.

<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" />

# Translations

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

# 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/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 using `./gradlew cleanNative buildNative`. Then use `./gradlew assembleDebug` or
Android Studio to build the apk.

# License

The project is licensed under the [MPLv2](LICENSE).
Update README.md 2018-09-14 19:17:20 +00:00			`# Fork of Syncthing-Android:`

			`[![License: MPLv2](https://img.shields.io/badge/License-MPLv2-blue.svg)](https://opensource.org/licenses/MPL-2.0)`
			`<a href="https://github.com/Catfriend1/syncthing-android/releases" alt="GitHub release"><img src="https://img.shields.io/github/release/Catfriend1/syncthing-android/all.svg" /></a>`
Update README.md 2018-09-16 10:04:25 +00:00			`<a href="https://f-droid.org/de/packages/com.github.catfriend1.syncthingandroid" alt="F-Droid release"><img src="https://img.shields.io/badge/f--droid-4158-brightgreen.svg" /></a>`
Update README.md 2018-09-14 19:17:20 +00:00
Update README.md 2018-08-19 22:30:06 +00:00			`# 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.`
Update README.md 2018-08-25 20:35:08 +00:00			`- Run condition bugs are fixed.`
			`- "Battery eater" problem is fixed.`
			`- Android 8+ support is on it's way.`
Rename app to "Syncthing-Fork" (#42) * Rename app to "Syncthing-Fork" * Update com.github.catfriend1.syncthingandroid.yml for F-Droid * Update README.md * Updated whatsnew 2018-09-01 20:33:13 +00:00			`- Many bug fixes, enhancements and more frequent releases.`
Update README.md 2018-08-19 22:30:06 +00:00
Update README.md 2018-09-01 20:36:56 +00:00			`A wrapper of [Syncthing](https://github.com/syncthing/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.`
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
Don't upgrade plugin to 3.0 yet, as it breaks lint https://stackoverflow.com/a/47127584/1837158 2017-11-13 02:09:26 +00:00			`<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" />`
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 README.md 2018-08-25 00:24:02 +00:00			`# Translations`

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

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`
			`- 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)`
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`
Update build instructions 2018-08-19 21:14:56 +00:00			`git clone https://github.com/Catfriend1/syncthing-android.git --recursive`. Alternatively, run
Revert "Revert build script changes" This reverts commit 18c419b2eda9f00cc4fcc1a444af11a864351106. 2017-10-24 05:55:28 +00:00			`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
Update build instructions 2018-08-19 21:14:56 +00:00			`A Linux VM, for example running Debian, is recommended to build this.`

			Build Syncthing using `./gradlew cleanNative 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).`