From 89e09d4682e9fff390db4e350cce2d9bfc9daa52 Mon Sep 17 00:00:00 2001 From: Mygod Date: Wed, 4 Apr 2018 16:20:58 -0700 Subject: [PATCH] Update build section Fixes #1728. --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6b3894b5..1e964ba8 100644 --- a/README.md +++ b/README.md @@ -20,10 +20,14 @@ A [shadowsocks](http://shadowsocks.org) client for Android, written in Kotlin. ### BUILD +You can check whether the latest commit builds under UNIX environment by checking Travis status. +Building on Windows is also possible since [#1570](https://github.com/shadowsocks/shadowsocks-android/pull/1570), +but probably painful. Further contributions regarding building on Windows are also welcome. + * Set environment variable `ANDROID_HOME` to `/path/to/android-sdk` * (optional) Set environment variable `ANDROID_NDK_HOME` to `/path/to/android-ndk` (default: `$ANDROID_HOME/ndk-bundle`) * Set environment variable `GOROOT_BOOTSTRAP` to `/path/to/go` -* Fetch submodules using `$ git submodule update --init --recursive` +* Clone the repo using `git clone --recurse-submodules ` or update submodules using `git submodule update --init --recursive` * Build it using Android Studio or gradle script ### TRANSLATE