Skip to content
Snippets Groups Projects
Unverified Commit da3ee71d authored by yi_Xu's avatar yi_Xu Committed by GitHub
Browse files

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
parent 62fb089e
No related branches found
No related tags found
No related merge requests found
name: Build Unsigned name: Build Unsigned
on: [push, pull_request] on:
workflow_dispatch:
push:
branches:
- main
paths-ignore:
- '.github/**'
- '.idea/**'
- '.gitignore'
- '.gitmodules'
- '**.md'
- 'LICENSE'
- 'NOTICE'
pull_request:
branches:
- main
paths-ignore:
- '.github/**'
- '.idea/**'
- '.gitignore'
- '.gitmodules'
- '**.md'
- 'LICENSE'
- 'NOTICE'
jobs: jobs:
BuildUnsigned: BuildUnsigned:
runs-on: ubuntu-latest runs-on: ubuntu-latest
......
...@@ -8,26 +8,20 @@ A Graphical user interface of [clash](https://github.com/Dreamacro/clash) for An ...@@ -8,26 +8,20 @@ A Graphical user interface of [clash](https://github.com/Dreamacro/clash) for An
Fully feature of [clash](https://github.com/Dreamacro/clash) ~~(Exclude `external-controller`~~ Fully feature of [clash](https://github.com/Dreamacro/clash) ~~(Exclude `external-controller`~~
### Requirement ### Requirement
* Android 5.0+ (minimum) - Android 5.0+ (minimum)
* Android 7.0+ (recommend) - Android 7.0+ (recommend)
* `armeabi-v7a` , `arm64-v8a`, `x86` or `x86_64` Architecture - `armeabi-v7a` , `arm64-v8a`, `x86` or `x86_64` Architecture
### License ### License
See also [LICENSE](./LICENSE) and [NOTICE](./NOTICE) See also [LICENSE](./LICENSE) and [NOTICE](./NOTICE)
### Privacy Policy
### Privacy Policy
See also [PRIVACY_POLICY.md](./PRIVACY_POLICY.md) See also [PRIVACY_POLICY.md](./PRIVACY_POLICY.md)
### Build ### Build
1. Update submodules 1. Update submodules
...@@ -38,7 +32,7 @@ See also [PRIVACY_POLICY.md](./PRIVACY_POLICY.md) ...@@ -38,7 +32,7 @@ See also [PRIVACY_POLICY.md](./PRIVACY_POLICY.md)
2. Install **OpenJDK 11**, **Android SDK**, **CMake** and **Golang** 2. Install **OpenJDK 11**, **Android SDK**, **CMake** and **Golang**
3. Create `local.properties` in project root with 3. Create `local.properties` in project root with
```properties ```properties
sdk.dir=/path/to/android-sdk sdk.dir=/path/to/android-sdk
...@@ -51,7 +45,7 @@ See also [PRIVACY_POLICY.md](./PRIVACY_POLICY.md) ...@@ -51,7 +45,7 @@ See also [PRIVACY_POLICY.md](./PRIVACY_POLICY.md)
storePassword=<key store password> storePassword=<key store password>
keyAlias=<key alias> keyAlias=<key alias>
keyPassword=<key password> keyPassword=<key password>
``` ```
5. Build 5. Build
...@@ -59,4 +53,4 @@ See also [PRIVACY_POLICY.md](./PRIVACY_POLICY.md) ...@@ -59,4 +53,4 @@ See also [PRIVACY_POLICY.md](./PRIVACY_POLICY.md)
./gradlew app:assembleFossRelease ./gradlew app:assembleFossRelease
``` ```
6. Pick `app-release-<arch>.apk` in `app/build/outputs/apks` 6. Pick `app-foss-<arch>-release-signed.apk` in `app/build/outputs/apk/foss/release/`
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment