diff --git a/README.md b/README.md index 42c68f61..6b3de5af 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -## syncthing-android +# syncthing-android [![tip for next commit](https://tip4commit.com/projects/914.svg)](https://tip4commit.com/github/Nutomic/syncthing-android) @@ -10,12 +10,20 @@ A wrapper of [syncthing](https://github.com/syncthing/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) [![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) -## Requirements +# 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 - sudo apt-get install build-essential - Android SDK 19+ and the Android Support Repository are required. - Use `git clone --recursive https://github.com/Nutomic/syncthing-android` to download the source and its submodules. -## Building +### Build instructions Use `gradlew assembleDebug` to compile the APK. @@ -29,14 +37,14 @@ The build process follows three phases: To check for updated gradle dependencies, run `gradle dependencyUpdates`. Additionally, the git modules in `ext/syncthing/src/github.com/syncthing/syncthing` and `libraries/android-support-v4-preferencefragment` may need to be updated. -## Getting Syncthing without building natively +### 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`, `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/libsyncthing.so`, `libs/armeabi-v7a/libsyncthing.so` or `libs/mips/libsyncthing.so` respectively. -## Development Notes +### Development Notes It is recommended to change the GUI and Listen Address ports for the debug app, eg to 8081 and 22001 respectively. @@ -45,6 +53,6 @@ The syncthing backend used for this android application provides a web interface - `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 +# License All code is licensed under the [MIT License](https://github.com/Nutomic/syncthing-android/blob/master/LICENSE).