diff --git a/.github/ISSUE_TEMPLATE/01-bug-report-en.md b/.github/ISSUE_TEMPLATE/01-bug-report-en.md new file mode 100644 index 0000000..ef23fc9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-bug-report-en.md @@ -0,0 +1,43 @@ +--- +name: "[English] Bug report" +about: Create a report to help us improve +title: "[BUG] " +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Logs** +if applicable, add logs to help detect problem + +**Device Info (please complete the following information):** + + - Device: [e.g. Pixel 4] + - ROM: [e.g: AOSP] + - ROM Version: + - Android Version [e.g. Oreo] + +**Application Info (please complete the following information):** + + - Version: [e.g. 1.1.10] + - Apk File Name: [e.g. app-release-arm64-v8a.apk] + - Distribution Channel: [e.g. Google Play] + +**Additional context** +Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/02-feature-request-en.md b/.github/ISSUE_TEMPLATE/02-feature-request-en.md new file mode 100644 index 0000000..2eb11d2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-feature-request-en.md @@ -0,0 +1,20 @@ +--- +name: "[English] Feature request" +about: Suggest an idea for this app +title: "[Feature Request] " +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/03-bug-report-zh-cn.md b/.github/ISSUE_TEMPLATE/03-bug-report-zh-cn.md new file mode 100644 index 0000000..d3b8624 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03-bug-report-zh-cn.md @@ -0,0 +1,42 @@ +--- +name: "[简体中文] 创建错误报告" +about: 创建错误报告以帮助我们改进应用 +title: "[BUG] " +labels: '' +assignees: '' + +--- + +**描述出现的错误** +请简洁的描述你遇到的错误 + +**如何复现该错误** +复现步骤: +1. ... +2. ... +3. ... +4. ... + +**预期行为** +清晰简单的描述你预期的应用应该表现的行为 + +**屏幕截图** +如果适用, 上传屏幕截图以帮助描述错误 + +**日志** + +如果适用, 上传日志以帮助侦测错误 + +**设备信息 (请完成一下信息):** + - 机型: [例如: Pixel 4] + - 系统/ROM: [例如: MIUI 11] + - Android 版本 [例如: Oreo] + - ROM版本 [例如: 20.3.19] + +**应用信息** + - 版本: [例如: 1.1.10] + - 安装包文件名: [例如: app-release-arm64-v8a.apk] + - 应用来源: [例如: Google Play] + +**附加信息** +其他的可能与改错误相关的信息 diff --git a/.github/ISSUE_TEMPLATE/04-feature-request-zh-cn.md b/.github/ISSUE_TEMPLATE/04-feature-request-zh-cn.md new file mode 100644 index 0000000..4c1ea83 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/04-feature-request-zh-cn.md @@ -0,0 +1,17 @@ +--- +name: "[简体中文] 功能请求" +about: 你希望的能够在应用中增加的功能 +title: "[Feature Request] " +labels: '' +assignees: '' + +--- + +**功能描述** +请清晰的描述你想要的功能 + +**描述你希望的实现方式** +清晰的描述应用应该如何实现该功能 + +**附加信息** +其他的与改功能相关的附加信息 diff --git a/README.md b/README.md index 1a126d3..cead363 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,8 @@ ## Clash for Android -A GUI for [clash](https://github.com/Dreamacro/clash) on Android - -> NOTICE: Early testing currently - +A Graphical user interface of [clash](https://github.com/Dreamacro/clash) for Android +Get it on Google Play or [Releases](https://github.com/Kr328/ClashForAndroid/releases) ### Feature @@ -15,9 +13,7 @@ Fully feature of [clash](https://github.com/Dreamacro/clash) ~~(Exclude `externa ### Requirement * Android 7.0+ -* `arm64` or `x86_64` architecture - - +* `armeabi-v7a` , `arm64-v8a`, `x86` or `x86_64` Architecture ### License @@ -39,7 +35,7 @@ See also [PRIVACY_POLICY.md](./PRIVACY_POLICY.md) git submodule update --init --recursive ``` -2. Install `Android SDK (include JDK)` ,`Android NDK` and `Golang` +2. Install `JDK 1.8`, `Android SDK` ,`Android NDK` and `Golang` 3. Configure `local.properties`