nutomic
/
syncthing-android
mirror of https://github.com/syncthing/syncthing-android.git
1
0
Fork 0
Code Releases Activity
syncthing-android/README.md

53 lines
2.6 KiB
Markdown
Raw Normal View History

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
Use Travis CI
2016-10-09 10:28:16 +00:00
[![Build Status](https://travis-ci.org/syncthing/syncthing-android.svg?branch=master)](https://travis-ci.org/syncthing/syncthing-android)
Added license badge
2016-10-09 10:30:33 +00:00
[![License: MPLv2](https://img.shields.io/badge/License-MPLv2-blue.svg)](https://opensource.org/licenses/MPL-2.0)
Added tip4commit badge (closes #102).
2014-08-25 15:27:18 +00:00
Updated README
2015-05-05 22:35:25 +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
Fixed screenshots in readme
2016-12-30 16:09:16 +00:00
<img src="src/main/play/en-GB/listing/phoneScreenshots/screenshot_phone_1.png" alt="screenshot 1" width="200" />
<img src="src/main/play/en-GB/listing/phoneScreenshots/screenshot_phone_2.png" alt="screenshot 2" width="200" />
<img src="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 Google Play and F-Droid badges
2016-04-30 05:06:24 +00:00
[<img alt="Get it on Google Play" src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png" height="80">](https://play.google.com/store/apps/details?id=com.nutomic.syncthingandroid) [<img alt="Get it on F-Droid" src="https://f-droid.org/badge/get-it-on.png" height="80">](https://f-droid.org/app/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))
Update build instructions
2015-11-15 17:10:34 +00:00
- Android NDK Platform
Improved and shortened build instructions
2014-12-06 21:32:26 +00:00
- 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
Update README.md with buld instructions (fixes #776)
2016-11-09 23:12:33 +00:00
This repository is using external dependencies so you have to initialize all submodules with --recursive option first time: `git clone https://github.com/syncthing/syncthing-android.git --recursive`.
Update build instructions
2015-11-15 17:10:34 +00:00
Set the `ANDROID_NDK` environment variable to the Android NDK folder (e.g. `export ANDROID_NDK=/opt/android_ndk`).
Build Go and Syncthing using `./make-all.bash`.
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
Added release script
2016-09-13 20:43:25 +00:00
To prepare a new release, execute `./prepare-release.bash`, and follow the instructions.
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
Remove redundant instructions for binary downloads Avoids building with outdated upstream binaries. There aren't different versions for ARM anymore, they are all called `arm` now. Add windows build.gradle file & build instructions
2015-03-06 14:26:05 +00:00
### Building on Windows
Prepare building environment for F-Droid.
2014-08-20 21:58:28 +00:00
build: Update windows build instructions (fixes #219)
2016-12-01 23:30:56 +00:00
To build the Syncthing app on Windows we need to have cygwin installed.
From a cygwin shell in the project directory, build Go using `./make-go.bash [arch]`
After Go is built, compile syncthing using `./make-syncthing.bash [arch]`
Lastly, use `./gradlew assembleDebug` in the project directory to compile the APK,
or use Android Studio to build/deploy the APK.
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
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).