ClashMetaForAndroid/README.md
yi_Xu da3ee71dfd
Docs: update readme (#1044)
* docs: update README.md

- Fix the path and name of the release.
- Format the style with markdownlint.

* docs: fix apk name

* ci: add paths-ignore for workflow
2021-06-17 22:10:03 +08:00

1.4 KiB

Clash for Android

A Graphical user interface of clash for Android

Get it on Google Play or Releases

Feature

Fully feature of clash (Exclude external-controller

Requirement

  • Android 5.0+ (minimum)
  • Android 7.0+ (recommend)
  • armeabi-v7a , arm64-v8a, x86 or x86_64 Architecture

License

See also LICENSE and NOTICE

Privacy Policy

See also PRIVACY_POLICY.md

Build

  1. Update submodules

    git submodule update --init --recursive
    
  2. Install OpenJDK 11, Android SDK, CMake and Golang

  3. Create local.properties in project root with

    sdk.dir=/path/to/android-sdk
    
  4. Create keystore.properties in project root with

    storeFile=/path/to/keystore/file
    storePassword=<key store password>
    keyAlias=<key alias>
    keyPassword=<key password>
    
  5. Build

    ./gradlew app:assembleFossRelease
    
  6. Pick app-foss-<arch>-release-signed.apk in app/build/outputs/apk/foss/release/