A ShadowsocksR client for Android
Scala C Makefile HTML C++ Java Other
Pull request Compare This branch is 295 commits ahead, 438 commits behind shadowsocks:master.
Latest commit 4439368 Jan 18, 2017 @LNDDYL LNDDYL committed with breakwa11 Update (#65)
* Update README.md

* Update zh-TW

* Update about.html

README.md

ShadowsocksR for Android

A shadowsocksR client for Android, written in Scala.

CI STATUS

Build Status

PREREQUISITES

  • JDK 1.8
  • SBT 0.13.0+
  • Android SDK
    • Build Tools 25+
    • Android Support Repository and Google Repository (see build.sbt for version)
  • Android NDK r12b+

BUILD

  • Set environment variable ANDROID_HOME to /path/to/android-sdk
  • Set environment variable ANDROID_NDK_HOME to /path/to/android-ndk
  • Create your key following the instructions at https://developer.android.com/studio/publish/app-signing.htmlf
  • Put your key in ~/.keystore
  • Create local.properties from local.properties.example with your own key information
  • Invoke the building like this
    git submodule update --init

    # Build the App
    sbt native-build clean android:package-release

BUILD on Mac OS X (with HomeBrew)

  • Install Android SDK and NDK by run brew install android-ndk android-sdk
  • Add export ANDROID_HOME=/usr/local/Cellar/android-sdk/$version to your .bashrc , then reopen the shell to load it.
  • Add export ANDROID_NDK_HOME=/usr/local/Cellar/android-ndk/$version to your .bashrc , then reopen the shell to load it.
  • echo "y" | android update sdk --filter tools,platform-tools,build-tools-23.0.2,android-23,extra-google-m2repository --no-ui -a
  • echo "y" | android update sdk --filter extra-android-m2repository --no-ui --no-https -a
  • Create your key following the instructions at http://developer.android.com/guide/publishing/app-signing.html#cert
  • Put your key in ~/.keystore
  • Create local.properties from local.properties.example with your own key information .
  • Invoke the building like this
    git submodule update --init

    # Build native binaries
    ./build.sh

    # Build the apk
    sbt clean android:package-release

OPEN SOURCE LICENSES

LICENSE

Copyright (C) 2016 by Max Lv <max.c.lv@gmail.com>
Copyright (C) 2016 by Mygod Studio <mygodstudio@gmail.com>

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.