syncthing-android/README.md

# syncthing-android

[![current build status](https://travis-ci.org/syncthing/syncthing-android.svg?branch=master)](https://travis-ci.org/syncthing/syncthing-android)
[![tip for next commit](https://tip4commit.com/projects/914.svg)](https://tip4commit.com/github/syncthing/syncthing-android)

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

<img src="graphics/screenshot_phone_1.png" alt="screenshot 1" width="200" /> 
<img src="graphics/screenshot_phone_2.png" alt="screenshot 2" width="200" /> 
<img src="graphics/screenshot_phone_3.png" alt="screenshot 3" width="200" />

[![Get it on Google Play](https://developer.android.com/images/brand/en_generic_rgb_wo_60.png)](https://play.google.com/store/apps/details?id=com.nutomic.syncthingandroid) [![Get it on F-Droid](https://f-droid.org/wiki/images/0/06/F-Droid-button_get-it-on.png)](https://f-droid.org/repository/browse/?fdid=com.nutomic.syncthingandroid)

# Translations

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

Translations can be updated using the [Transifex client](http://docs.transifex.com/developer/client/), using commands `tx push -s` and `tx pull -a`.

# Building

### Requirements
- Android SDK Platform (for the `compileSdkVersion` specified in [build.gradle](build.gradle))
- Android Support Repository

### Build instructions

Use `./gradlew assembleDebug` in the project directory to compile the APK.

To check for updated gradle dependencies, run `gradle dependencyUpdates`. Additionally, the git submodule in `ext/syncthing/src/github.com/syncthing/syncthing` may need to be updated.


### Getting Syncthing without building natively

To get Syncthing app for Android running on you device/emulator the native syncthing binary has to be available. There are multiple ways to get the native syncthing binary:
- open the Syncthing apk (the one taken from the play store) running on your device as a zip, extract the `lib/` folder into your project directory and rename it to `libs/`.
- Depending on your target architecture, download `syncthing-linux-386` or `syncthing-linux-armv5` from [syncthing releases](https://github.com/syncthing/syncthing/releases), and extract the binary to `libs/x86/libsyncthing.so` or `libs/armeabi/libsyncthing.so` respectively.


### Development Notes

It is recommended to change the GUI and Listen Address ports for the debug app, eg to 8081 and 22001 respectively.

The syncthing backend used for this android application provides a web interface by default. It can be accessed via the Settings menu -> 'Web GUI'. It is quite helpful to access this web interface from your development machine. Read [android documentation](http://developer.android.com/tools/devices/emulator.html#redirection) on how to access the network of your emulator. Or use the following steps to connect to the single currently running emulator/AVD.
- `telnet localhost 5554`
- `redir add tcp:18080:8080`
- Start syncthing app on your emulator and access the web interface from you favorite browser of your development machine via [http://127.0.0.1:18080](http://127.0.0.1:18080)

# 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
Fixed build status image It was still pointing at Nutomic/syncthing-android, and Travis CI doesn't seem to forward that. 2014-12-04 11:38:32 +00:00			`[![current build status](https://travis-ci.org/syncthing/syncthing-android.svg?branch=master)](https://travis-ci.org/syncthing/syncthing-android)`
Project's owner changed, fix tip4commit link The banner still has the correct image link. 2015-03-04 13:52:48 +00:00			`[![tip for next commit](https://tip4commit.com/projects/914.svg)](https://tip4commit.com/github/syncthing/syncthing-android)`
Added tip4commit badge (closes #102). 2014-08-25 15:27:18 +00:00
Prepare building environment for F-Droid. 2014-08-20 21:58:28 +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
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			`<img src="graphics/screenshot_phone_1.png" alt="screenshot 1" width="200" />`
			`<img src="graphics/screenshot_phone_2.png" alt="screenshot 2" width="200" />`
			`<img src="graphics/screenshot_phone_3.png" alt="screenshot 3" width="200" />`

Added F-Droid download badge to Readme. 2014-08-24 17:01:15 +00:00			`[![Get it on Google Play](https://developer.android.com/images/brand/en_generic_rgb_wo_60.png)](https://play.google.com/store/apps/details?id=com.nutomic.syncthingandroid) [![Get it on F-Droid](https://f-droid.org/wiki/images/0/06/F-Droid-button_get-it-on.png)](https://f-droid.org/repository/browse/?fdid=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/).`

			Translations can be updated using the [Transifex client](http://docs.transifex.com/developer/client/), using commands `tx push -s` and `tx pull -a`.

			`# Building`

			`### Requirements`
Improved and shortened build instructions 2014-12-06 21:32:26 +00:00			- Android SDK Platform (for the `compileSdkVersion` specified in [build.gradle](build.gradle))
			`- Android Support Repository`
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
Improved and shortened build instructions 2014-12-06 21:32:26 +00:00			Use `./gradlew assembleDebug` in the project directory to compile the APK.
Prepare building environment for F-Droid. 2014-08-20 21:58:28 +00:00
Improved and shortened build instructions 2014-12-06 21:32:26 +00:00			To check for updated gradle dependencies, run `gradle dependencyUpdates`. Additionally, the git submodule in `ext/syncthing/src/github.com/syncthing/syncthing` may need to be updated.
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
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			`### Getting Syncthing without building natively`
Prepare building environment for F-Droid. 2014-08-20 21:58:28 +00:00
			`To get Syncthing app for Android running on you device/emulator the native syncthing binary has to be available. There are multiple ways to get the native syncthing binary:`
			- open the Syncthing apk (the one taken from the play store) running on your device as a zip, extract the `lib/` folder into your project directory and rename it to `libs/`.
Link to the in-use Syncthing org 2015-03-06 14:14:29 +00:00			- Depending on your target architecture, download `syncthing-linux-386` or `syncthing-linux-armv5` from [syncthing releases](https://github.com/syncthing/syncthing/releases), and extract the binary to `libs/x86/libsyncthing.so` or `libs/armeabi/libsyncthing.so` respectively.
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
Added MIT license. 2014-05-05 21:52:51 +00:00
Reformatted README, added Translation instructions. 2014-09-25 10:39:53 +00:00			`### Development Notes`
Update README.md Add how to acces web frontent from devopment machine 2014-08-19 18:24:36 +00:00
Improved development notes. 2014-08-24 15:24:28 +00:00			`It is recommended to change the GUI and Listen Address ports for the debug app, eg to 8081 and 22001 respectively.`

Update README.md There was still a typo. And another small rephrase. 2014-08-20 12:18:19 +00:00			`The syncthing backend used for this android application provides a web interface by default. It can be accessed via the Settings menu -> 'Web GUI'. It is quite helpful to access this web interface from your development machine. Read [android documentation](http://developer.android.com/tools/devices/emulator.html#redirection) on how to access the network of your emulator. Or use the following steps to connect to the single currently running emulator/AVD.`
Update README.md Improve description 2014-08-19 18:26:52 +00:00			- `telnet localhost 5554`
			- `redir add tcp:18080:8080`
Update README.md There was still a typo. And another small rephrase. 2014-08-20 12:18:19 +00:00			`- Start syncthing app on your emulator and access the web interface from you favorite browser of your development machine via [http://127.0.0.1:18080](http://127.0.0.1:18080)`
Update README.md Add how to acces web frontent from devopment machine 2014-08-19 18:24:36 +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).`