GitHub - shadowsocks/shadowsocks-android: A shadowsocks client for Android

README.md

Shadowsocks for Android

for Android & Chrome OS (beta)
for Android TV (beta)

PREREQUISITES

• JDK 1.8
• Android SDK
  • Android NDK

BUILD

You can check whether the latest commit builds under UNIX environment by checking Travis status.

• Clone the repo using git clone --recurse-submodules <repo> or update submodules using git submodule update --init --recursive
• Build it using Android Studio or gradle script

BUILD WITH DOCKER

mkdir build
sudo chown 3434:3434 build
docker run --rm -v ${PWD}/build:/build circleci/android:api-28-ndk bash -c "cd /build; git clone https://github.com/shadowsocks/shadowsocks-android; cd shadowsocks-android; git submodule update --init --recursive; ./gradlew assembleDebug"

CONTRIBUTING

If you are interested in contributing or getting involved with this project, please read the CONTRIBUTING page for more information. The page can be found here.

TRANSLATE

OPEN SOURCE LICENSES

• redsocks: APL 2.0
• mbed TLS: APL 2.0
• libevent: BSD
• tun2socks: BSD
• pcre: BSD
• libancillary: BSD
• shadowsocks-libev: GPLv3
• libev: GPLv2
• libsodium: ISC

LICENSE

Copyright (C) 2017 by Max Lv <[email protected]>
Copyright (C) 2017 by Mygod Studio <[email protected]>

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/.