syncthing-android/README.md

## syncthing-android

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

[![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)

## Building

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 a 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`, `syncthing-linux-armv5`, `syncthing-linux-armv7` or `syncthing-linux-mips` from [syncthing releases](https://github.com/calmh/syncthing/releases), and extract the binary to `libs/x86/libsyncthing.so`, `libs/armeabi-v7a/libsyncthing.so`, `libs/armeabi/libsyncthing.so` or `libs/mips/libsyncthing.so` respectively.
- Set up a syncthing compile and run `gradle buildNative` in your syncthing-android directory.

Then, run `gradle assembleDebug`.

## Development Notes

The syncthing backend used for this android application provides a webinterface by default. It can be acces via the Settings menu -> 'Web GUI'. It is quite helpful to access this web interface from you development machine. Read [android documentation](http://developer.android.com/tools/devices/emulator.html#redirection) on how to do so or execute the following steps (assuming you have only one emulator/avd started)
- `telnet localhost 5554`
- `redir add tcp:18080:8080`
- Start synchting app on your emulator and access the web ui from you favorite browser of your development machine via [http://127.0.0.1:18080](http://127.0.0.1:18080)

## License

All code is licensed under the [MIT License](https://github.com/Nutomic/syncthing-android/blob/master/LICENSE).
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			`## syncthing-android`

Change "port" to "wrapper" I think that's more accurate; port sounds like you rewrote it in Java to me. :) 2014-07-29 06:56:02 +00:00			`A wrapper of [syncthing](https://github.com/calmh/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 Play Store link to README. 2014-05-10 11:40:13 +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)`

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			`## Building`

Improve documentation 2014-08-16 19:19:23 +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 a 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/`.
Added mips compilation code (yet unsupported). 2014-05-18 13:24:14 +00:00			- Depending on your target architecture, download `syncthing-linux-386`, `syncthing-linux-armv5`, `syncthing-linux-armv7` or `syncthing-linux-mips` from [syncthing releases](https://github.com/calmh/syncthing/releases), and extract the binary to `libs/x86/libsyncthing.so`, `libs/armeabi-v7a/libsyncthing.so`, `libs/armeabi/libsyncthing.so` or `libs/mips/libsyncthing.so` respectively.
Added gradle flavors for different native platforms, and buildNative task. 2014-05-17 20:57:04 +00:00			- Set up a syncthing compile and run `gradle buildNative` in your syncthing-android directory.
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
Execute syncthing binary from console instead of loading it as a library. This makes everything easier, as we can now use standard syncthing releases instead of custom compiles, and don't have to hardcode the data folder. 2014-05-14 08:23:15 +00:00			Then, run `gradle assembleDebug`.
Added MIT license. 2014-05-05 21:52:51 +00:00
Update README.md fix bad headline 2014-08-19 18:28:49 +00:00			`## Development Notes`
Update README.md Add how to acces web frontent from devopment machine 2014-08-19 18:24:36 +00:00
Update README.md Improve description 2014-08-19 18:26:52 +00:00			`The syncthing backend used for this android application provides a webinterface by default. It can be acces via the Settings menu -> 'Web GUI'. It is quite helpful to access this web interface from you development machine. Read [android documentation](http://developer.android.com/tools/devices/emulator.html#redirection) on how to do so or execute the following steps (assuming you have only one emulator/avd started)`
			- `telnet localhost 5554`
			- `redir add tcp:18080:8080`
Update README.md Add how to acces web frontent from devopment machine 2014-08-19 18:24:36 +00:00			`- Start synchting app on your emulator and access the web ui from you favorite browser of your development machine via [http://127.0.0.1:18080](http://127.0.0.1:18080)`

Added MIT license. 2014-05-05 21:52:51 +00:00			`## License`

			`All code is licensed under the [MIT License](https://github.com/Nutomic/syncthing-android/blob/master/LICENSE).`