mirror of
https://github.com/syncthing/syncthing-android.git
synced 2024-11-22 12:21:15 +00:00
Update build instructions
This commit is contained in:
parent
9559d0c2d9
commit
5749b98b92
1 changed files with 12 additions and 19 deletions
31
README.md
31
README.md
|
@ -16,37 +16,30 @@ A wrapper of [Syncthing](https://github.com/syncthing/syncthing) for Android.
|
||||||
|
|
||||||
The project is translated on [Transifex](https://www.transifex.com/projects/p/syncthing-android/).
|
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
|
# Building
|
||||||
|
|
||||||
### Requirements
|
### Dependencies
|
||||||
- Android SDK Platform (for the `compileSdkVersion` specified in [build.gradle](build.gradle))
|
- Android SDK (you can skip this if you are using Android Studio)
|
||||||
- Android NDK Platform
|
- Android NDK (`$ANDROID_NDK_HOME` should point at the root directory of your NDK)
|
||||||
- Android Support Repository
|
- Go (see [here](https://docs.syncthing.net/dev/building.html#prerequisites) for the required version)
|
||||||
|
|
||||||
### Build instructions
|
### Build instructions
|
||||||
|
|
||||||
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`.
|
Make sure you clone the project with
|
||||||
|
`git clone https://github.com/syncthing/syncthing-android.git --recursive`. Alternatively, run
|
||||||
Set the `ANDROID_NDK` environment variable to the Android NDK folder (e.g. `export ANDROID_NDK=/opt/android_ndk`).
|
`git submodule init && git submodule update` in the project folder.
|
||||||
Build Go and Syncthing using `./make-all.bash`.
|
|
||||||
Use `./gradlew assembleDebug` in the project directory to compile the APK.
|
|
||||||
|
|
||||||
To prepare a new release, execute `./prepare-release.bash`, and follow the instructions.
|
|
||||||
|
|
||||||
To check for updated gradle dependencies, run `gradle dependencyUpdates`. Additionally, the git submodule in `go/src/github.com/syncthing/syncthing/` may need to be updated.
|
|
||||||
|
|
||||||
|
Build Syncthing using `./syncthing/build-syncthing.bash`. Then use `./gradlew assembleDebug` or
|
||||||
|
Android Studio to build the apk.
|
||||||
|
|
||||||
### Building on Windows
|
### Building on Windows
|
||||||
|
|
||||||
To build the Syncthing app on Windows we need to have cygwin installed.
|
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]`
|
From a cygwin shell in the project directory, build Syncthing using `./syncthing/build-syncthing.bash`
|
||||||
After Go is built, compile syncthing using `./make-syncthing.bash [arch]`
|
|
||||||
|
|
||||||
Lastly, use `./gradlew assembleDebug` in the project directory to compile the APK,
|
Lastly, use `./gradlew assembleDebug` in the project directory to compile the APK, or use Android
|
||||||
or use Android Studio to build/deploy the APK.
|
Studio to build/deploy the APK.
|
||||||
|
|
||||||
# License
|
# License
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue