|
|
@@ -1,3 +1,44 @@
|
|
|
-## CFA
|
|
|
+## Clash Meta for Android
|
|
|
|
|
|
-?
|
|
|
+A Graphical user interface of [Clash.Meta](https://github.com/MetaCubeX/Clash.Meta) for Android
|
|
|
+
|
|
|
+### Feature
|
|
|
+
|
|
|
+Feature of [Clash.Meta](https://github.com/MetaCubeX/Clash.Meta)
|
|
|
+
|
|
|
+### Requirement
|
|
|
+
|
|
|
+- Android 5.0+ (minimum)
|
|
|
+- Android 7.0+ (recommend)
|
|
|
+- `armeabi-v7a` , `arm64-v8a`, `x86` or `x86_64` Architecture
|
|
|
+
|
|
|
+### Build
|
|
|
+
|
|
|
+1. Update submodules
|
|
|
+
|
|
|
+ ```bash
|
|
|
+ git submodule update --init --recursive
|
|
|
+ ```
|
|
|
+
|
|
|
+2. Install **OpenJDK 11**, **Android SDK**, **CMake** and **Golang**
|
|
|
+
|
|
|
+3. Create `local.properties` in project root with
|
|
|
+
|
|
|
+ ```properties
|
|
|
+ sdk.dir=/path/to/android-sdk
|
|
|
+ ```
|
|
|
+
|
|
|
+4. Create `signing.properties` in project root with
|
|
|
+
|
|
|
+ ```properties
|
|
|
+ keystore.path=/path/to/keystore/file
|
|
|
+ keystore.password=<key store password>
|
|
|
+ key.alias=<key alias>
|
|
|
+ key.password=<key password>
|
|
|
+ ```
|
|
|
+
|
|
|
+5. Build
|
|
|
+
|
|
|
+ ```bash
|
|
|
+ ./gradlew app:assembleMeta-AlphaRelease
|
|
|
+ ```
|