docs(readme): rewrite the README in both languages
Open with the project links and a feature list checked against the app, list the downloads per platform, document link imports and Android automation, and describe what a source build needs today. The Linux note now names the runtime tray library and applies only to the AppImage and .rpm, since the .deb declares its dependencies, and the Android build no longer asks for an ANDROID_NDK variable. The preview mockups keep their frames and now show the current UI: the sidebar, the reworked dashboard and the floating dock.
This commit is contained in:
chen08209
@@ -1,135 +1,137 @@
|
||||
<div>
|
||||
<div align="center">
|
||||
|
||||
[**简体中文**](README_zh_CN.md)
|
||||
<img src="assets/images/icon.png" alt="FlClash" width="88">
|
||||
|
||||
# FlClash
|
||||
|
||||
A multi-platform proxy client based on ClashMeta. Simple to use, open source and ad-free.
|
||||
|
||||
**English** · [简体中文](README_zh_CN.md)
|
||||
|
||||
[](https://github.com/chen08209/FlClash/releases/latest)
|
||||
[](https://github.com/chen08209/FlClash/releases)
|
||||
[](LICENSE)
|
||||
[](https://t.me/FlClash)
|
||||
|
||||
[Website](https://chen08209.github.io/FlClash/) · [Download](#download) · [Changelog](CHANGELOG.md) · [Build from source](#build-from-source)
|
||||
|
||||
</div>
|
||||
|
||||
## FlClash
|
||||
|
||||
[](https://github.com/chen08209/FlClash/releases/)[](https://github.com/chen08209/FlClash/releases/)[](LICENSE)
|
||||
|
||||
[](https://t.me/FlClash)
|
||||
|
||||
A multi-platform proxy client based on ClashMeta, simple and easy to use, open-source and ad-free.
|
||||
|
||||
<p align="center">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="snapshots/preview-dark.png">
|
||||
<img alt="FlClash on desktop and mobile" src="snapshots/preview.png" width="90%">
|
||||
</picture>
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="snapshots/preview-dark.png">
|
||||
<img alt="FlClash dashboard on a MacBook and a phone" src="snapshots/preview.png" width="92%">
|
||||
</picture>
|
||||
</p>
|
||||
|
||||
## Features
|
||||
|
||||
✈️ Multi-platform: Android, Windows, macOS and Linux
|
||||
|
||||
💻 Adaptive multiple screen sizes, Multiple color themes available
|
||||
|
||||
💡 Based on Material You Design, [Surfboard](https://github.com/getsurfboard/surfboard)-like UI
|
||||
|
||||
☁️ Supports data sync via WebDAV
|
||||
|
||||
✨ Support subscription link, Dark mode
|
||||
|
||||
## Use
|
||||
|
||||
### Linux
|
||||
|
||||
⚠️ Make sure to install the following dependencies before using them
|
||||
|
||||
```bash
|
||||
sudo apt-get install libayatana-appindicator3-dev
|
||||
```
|
||||
|
||||
### Android
|
||||
|
||||
Support the following actions
|
||||
|
||||
```bash
|
||||
com.follow.clash.action.START
|
||||
|
||||
com.follow.clash.action.STOP
|
||||
|
||||
com.follow.clash.action.TOGGLE
|
||||
```
|
||||
- **One app for Android, Windows, macOS and Linux**, with x64 and ARM64 builds on the desktop.
|
||||
- **mihomo (Clash.Meta) core** with rule routing, proxy groups, latency tests, system proxy and TUN mode.
|
||||
- **Profiles** from a subscription link or a file, with a built-in editor, override scripts, and custom rules,
|
||||
proxies and proxy groups.
|
||||
- **Live views** of connections, requests, DNS queries and logs.
|
||||
- **Material You design** with dynamic color, light and dark themes, and layouts that adapt from phones to desktops.
|
||||
- **Backup and restore** through WebDAV or a local file.
|
||||
- **Platform touches**: a Quick Settings tile, per-app proxy and Android TV support on Android; a tray menu and
|
||||
global hotkeys on the desktop.
|
||||
- **Open source and ad-free**, licensed under GPL-3.0.
|
||||
|
||||
## Download
|
||||
|
||||
<a href="https://chen08209.github.io/FlClash-fdroid-repo/repo?fingerprint=789D6D32668712EF7672F9E58DEEB15FBD6DCEEC5AE7A4371EA72F2AAE8A12FD"><img alt="Get it on F-Droid" src="snapshots/get-it-on-fdroid.svg" width="200px"/></a> <a href="https://github.com/chen08209/FlClash/releases"><img alt="Get it on GitHub" src="snapshots/get-it-on-github.svg" width="200px"/></a>
|
||||
Get the latest build from [GitHub Releases](https://github.com/chen08209/FlClash/releases/latest), or open the
|
||||
[website](https://chen08209.github.io/FlClash/#download), which picks the right file for your device.
|
||||
|
||||
### Homebrew
|
||||
| Platform | Packages | Notes |
|
||||
| --- | --- | --- |
|
||||
| Android | APK for `arm64-v8a`, `armeabi-v7a` and `x86_64` | Most phones use `arm64-v8a`. Also on the F-Droid repository below. |
|
||||
| Windows 10 and later | Installer (`.exe`) or portable `.zip`, for x64 and ARM64 | Pick ARM64 on Snapdragon and other ARM laptops. |
|
||||
| macOS 12 and later | DMG for Apple Silicon and Intel | Also on Homebrew. |
|
||||
| Linux | `.deb`, `.rpm` and AppImage, for x64 and ARM64 | See the tray note below. |
|
||||
|
||||
<p>
|
||||
<a href="https://chen08209.github.io/FlClash-fdroid-repo/repo?fingerprint=789D6D32668712EF7672F9E58DEEB15FBD6DCEEC5AE7A4371EA72F2AAE8A12FD"><img alt="Get it on F-Droid" src="snapshots/get-it-on-fdroid.svg" height="56"></a>
|
||||
<a href="https://github.com/chen08209/FlClash/releases/latest"><img alt="Get it on GitHub" src="snapshots/get-it-on-github.svg" height="56"></a>
|
||||
</p>
|
||||
|
||||
**Homebrew**
|
||||
|
||||
```bash
|
||||
brew tap chen08209/tap
|
||||
brew install --cask flclash
|
||||
```
|
||||
|
||||
## Build
|
||||
**Linux tray icon**
|
||||
|
||||
1. Update submodules
|
||||
```bash
|
||||
git submodule update --init --recursive
|
||||
```
|
||||
The `.deb` package installs its own dependencies. With the AppImage or the `.rpm`, install the AyatanaAppIndicator
|
||||
library so the tray icon can show:
|
||||
|
||||
2. Install `Flutter` and `Golang` environment
|
||||
```bash
|
||||
sudo apt-get install libayatana-appindicator3-1 # Debian and Ubuntu
|
||||
sudo dnf install libayatana-appindicator-gtk3 # Fedora
|
||||
```
|
||||
|
||||
3. Build Application
|
||||
## Usage
|
||||
|
||||
- android
|
||||
**Import a profile from a link.** Opening a link in this form imports the subscription into FlClash. The `clashmeta://`
|
||||
and `flclash://` schemes work the same way.
|
||||
|
||||
1. Install `Android SDK`, `Android NDK`
|
||||
```text
|
||||
clash://install-config?url=<URL-encoded subscription link>
|
||||
```
|
||||
|
||||
2. Set `ANDROID_NDK` environment variable
|
||||
**Automate on Android.** Tasker, MacroDroid and similar apps can start, stop or toggle the proxy by starting an
|
||||
activity with one of these actions:
|
||||
|
||||
3. Run build script
|
||||
```text
|
||||
com.follow.clash.action.START
|
||||
com.follow.clash.action.STOP
|
||||
com.follow.clash.action.TOGGLE
|
||||
```
|
||||
|
||||
```bash
|
||||
dart setup.dart android
|
||||
```
|
||||
From a computer, the same works over adb:
|
||||
|
||||
- windows
|
||||
```bash
|
||||
adb shell am start -a com.follow.clash.action.TOGGLE
|
||||
```
|
||||
|
||||
1. Requires a Windows client
|
||||
## Build from source
|
||||
|
||||
2. Install `GCC`, `Inno Setup`
|
||||
You need [Flutter](https://docs.flutter.dev/get-started/install) 3.47 (release builds use 3.47.4),
|
||||
[Go](https://go.dev/dl/) 1.26 and [Rust](https://rustup.rs/) installed through rustup. Each platform builds on its own
|
||||
host, except Android, which builds anywhere.
|
||||
|
||||
3. Run build script
|
||||
```bash
|
||||
git clone --recursive https://github.com/chen08209/FlClash.git
|
||||
cd FlClash
|
||||
flutter pub get
|
||||
dart setup.dart android # or windows, macos, linux
|
||||
```
|
||||
|
||||
```bash
|
||||
dart setup.dart windows
|
||||
```
|
||||
Packages land in `dist/`. The Go core and the Rust libraries are compiled as part of the Flutter build.
|
||||
|
||||
- linux
|
||||
| Platform | Also needed |
|
||||
| --- | --- |
|
||||
| Android | Android SDK with the NDK. Add `--arch arm64` to build a single ABI. |
|
||||
| Windows | GCC (MinGW-w64) for the core and [Inno Setup](https://jrsoftware.org/isinfo.php) 6 for the installer. |
|
||||
| macOS | Xcode and Node.js. The script installs `appdmg` through npm. |
|
||||
| Linux | Debian or Ubuntu. The script installs the build packages with apt and downloads `appimagetool`. |
|
||||
|
||||
1. Requires a Linux client
|
||||
Run `dart setup.dart --help` for the remaining options, such as `--targets` to build only some package formats.
|
||||
|
||||
2. Dependencies are auto-installed by setup script, or manually:
|
||||
```bash
|
||||
sudo apt-get install -y libayatana-appindicator3-dev
|
||||
```
|
||||
## Support
|
||||
|
||||
3. Run build script
|
||||
Starring the repository is the easiest way to support the project. Questions and announcements go to the
|
||||
[Telegram channel](https://t.me/FlClash); bugs and feature requests go to
|
||||
[GitHub Issues](https://github.com/chen08209/FlClash/issues).
|
||||
|
||||
```bash
|
||||
dart setup.dart linux
|
||||
```
|
||||
<a href="https://star-history.com/#chen08209/FlClash&Date">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=chen08209/FlClash&type=Date&theme=dark">
|
||||
<img alt="Star history" src="https://api.star-history.com/svg?repos=chen08209/FlClash&type=Date" width="640">
|
||||
</picture>
|
||||
</a>
|
||||
|
||||
- macOS
|
||||
## License
|
||||
|
||||
1. Requires a macOS client
|
||||
|
||||
2. Run build script
|
||||
|
||||
```bash
|
||||
dart setup.dart macos
|
||||
```
|
||||
|
||||
## Star
|
||||
|
||||
The easiest way to support developers is to click on the star (⭐) at the top of the page.
|
||||
|
||||
<p style="text-align: center;">
|
||||
<a href="https://api.star-history.com/svg?repos=chen08209/FlClash&Date">
|
||||
<img alt="start" width=50% src="https://api.star-history.com/svg?repos=chen08209/FlClash&Date"/>
|
||||
</a>
|
||||
</p>
|
||||
FlClash is released under the [GPL-3.0 license](LICENSE).
|
||||
|
||||
+91
-96
@@ -1,135 +1,130 @@
|
||||
<div>
|
||||
<div align="center">
|
||||
|
||||
[**English**](README.md)
|
||||
<img src="assets/images/icon.png" alt="FlClash" width="88">
|
||||
|
||||
# FlClash
|
||||
|
||||
基于 ClashMeta 的多平台代理客户端，简单易用，开源无广告。
|
||||
|
||||
[English](README.md) · **简体中文**
|
||||
|
||||
[](https://github.com/chen08209/FlClash/releases/latest)
|
||||
[](https://github.com/chen08209/FlClash/releases)
|
||||
[](LICENSE)
|
||||
[](https://t.me/FlClash)
|
||||
|
||||
[官网](https://chen08209.github.io/FlClash/zh/) · [下载](#下载) · [更新日志](CHANGELOG.md) · [从源码构建](#从源码构建)
|
||||
|
||||
</div>
|
||||
|
||||
## FlClash
|
||||
|
||||
[](https://github.com/chen08209/FlClash/releases/)[](https://github.com/chen08209/FlClash/releases/)[](LICENSE)
|
||||
|
||||
[](https://t.me/FlClash)
|
||||
|
||||
基于ClashMeta的多平台代理客户端，简单易用，开源无广告。
|
||||
|
||||
<p align="center">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="snapshots/preview-dark.png">
|
||||
<img alt="FlClash on desktop and mobile" src="snapshots/preview.png" width="90%">
|
||||
</picture>
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="snapshots/preview-dark.png">
|
||||
<img alt="FlClash 在 MacBook 与手机上的仪表盘" src="snapshots/preview.png" width="92%">
|
||||
</picture>
|
||||
</p>
|
||||
|
||||
## Features
|
||||
## 功能
|
||||
|
||||
✈️ 多平台: Android, Windows, macOS and Linux
|
||||
- **一个应用覆盖 Android、Windows、macOS 和 Linux**，桌面端同时提供 x64 与 ARM64 版本。
|
||||
- **mihomo（Clash.Meta）内核**：规则分流、代理组、延迟测试、系统代理与 TUN 模式。
|
||||
- **配置管理**：通过订阅链接或文件导入配置，内置编辑器，支持覆写脚本以及自定义规则、代理和代理组。
|
||||
- **实时查看**连接、请求、DNS 查询和日志。
|
||||
- **Material You 设计**：支持动态取色、浅色与深色主题，布局随屏幕从手机到桌面自适应。
|
||||
- **备份与恢复**：通过 WebDAV 或本地文件。
|
||||
- **平台细节**：Android 上有快捷设置磁贴、分应用代理和 Android TV 支持；桌面端有托盘菜单和全局快捷键。
|
||||
- **开源无广告**，以 GPL-3.0 协议发布。
|
||||
|
||||
💻 自适应多个屏幕尺寸,多种颜色主题可供选择
|
||||
## 下载
|
||||
|
||||
💡 基本 Material You 设计, 类[Surfboard](https://github.com/getsurfboard/surfboard)用户界面
|
||||
从 [GitHub Releases](https://github.com/chen08209/FlClash/releases/latest) 获取最新版本，或打开
|
||||
[官网](https://chen08209.github.io/FlClash/zh/#download)，它会自动为你的设备选好安装包。
|
||||
|
||||
☁️ 支持通过WebDAV同步数据
|
||||
| 平台 | 安装包 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| Android | `arm64-v8a`、`armeabi-v7a`、`x86_64` 三种 APK | 绝大多数手机选 `arm64-v8a`。也可以通过下方的 F-Droid 仓库安装。 |
|
||||
| Windows 10 及以上 | 安装版（`.exe`）或便携版（`.zip`），分 x64 与 ARM64 | 骁龙等 ARM 架构笔记本选 ARM64。 |
|
||||
| macOS 12 及以上 | Apple Silicon 与 Intel 两种 DMG | 也可以通过 Homebrew 安装。 |
|
||||
| Linux | `.deb`、`.rpm` 和 AppImage，分 x64 与 ARM64 | 托盘依赖见下方说明。 |
|
||||
|
||||
✨ 支持一键导入订阅, 深色模式
|
||||
<p>
|
||||
<a href="https://chen08209.github.io/FlClash-fdroid-repo/repo?fingerprint=789D6D32668712EF7672F9E58DEEB15FBD6DCEEC5AE7A4371EA72F2AAE8A12FD"><img alt="Get it on F-Droid" src="snapshots/get-it-on-fdroid.svg" height="56"></a>
|
||||
<a href="https://github.com/chen08209/FlClash/releases/latest"><img alt="Get it on GitHub" src="snapshots/get-it-on-github.svg" height="56"></a>
|
||||
</p>
|
||||
|
||||
## Use
|
||||
|
||||
### Linux
|
||||
|
||||
⚠️ 使用前请确保安装以下依赖
|
||||
|
||||
```bash
|
||||
sudo apt-get install libayatana-appindicator3-dev
|
||||
```
|
||||
|
||||
### Android
|
||||
|
||||
支持下列操作
|
||||
|
||||
```bash
|
||||
com.follow.clash.action.START
|
||||
|
||||
com.follow.clash.action.STOP
|
||||
|
||||
com.follow.clash.action.TOGGLE
|
||||
```
|
||||
|
||||
## Download
|
||||
|
||||
<a href="https://chen08209.github.io/FlClash-fdroid-repo/repo?fingerprint=789D6D32668712EF7672F9E58DEEB15FBD6DCEEC5AE7A4371EA72F2AAE8A12FD"><img alt="Get it on F-Droid" src="snapshots/get-it-on-fdroid.svg" width="200px"/></a> <a href="https://github.com/chen08209/FlClash/releases"><img alt="Get it on GitHub" src="snapshots/get-it-on-github.svg" width="200px"/></a>
|
||||
|
||||
### Homebrew
|
||||
**Homebrew**
|
||||
|
||||
```bash
|
||||
brew tap chen08209/tap
|
||||
brew install --cask flclash
|
||||
```
|
||||
|
||||
## Build
|
||||
**Linux 托盘图标**
|
||||
|
||||
1. 更新 submodules
|
||||
```bash
|
||||
git submodule update --init --recursive
|
||||
```
|
||||
`.deb` 安装包会自动安装所需依赖。使用 AppImage 或 `.rpm` 时，需要先安装 AyatanaAppIndicator 库，托盘图标才能显示：
|
||||
|
||||
2. 安装 `Flutter` 以及 `Golang` 环境
|
||||
```bash
|
||||
sudo apt-get install libayatana-appindicator3-1 # Debian 与 Ubuntu
|
||||
sudo dnf install libayatana-appindicator-gtk3 # Fedora
|
||||
```
|
||||
|
||||
3. 构建应用
|
||||
## 使用
|
||||
|
||||
- android
|
||||
**通过链接导入配置。** 打开下面格式的链接，即可把订阅导入 FlClash。`clashmeta://` 和 `flclash://` 开头的链接同样可用。
|
||||
|
||||
1. 安装 `Android SDK` , `Android NDK`
|
||||
```text
|
||||
clash://install-config?url=<经过 URL 编码的订阅链接>
|
||||
```
|
||||
|
||||
2. 设置 `ANDROID_NDK` 环境变量
|
||||
**Android 自动化。** Tasker、MacroDroid 等应用可以用下面的 Action 启动 Activity，从而启动、停止或切换代理：
|
||||
|
||||
3. 运行构建脚本
|
||||
```text
|
||||
com.follow.clash.action.START
|
||||
com.follow.clash.action.STOP
|
||||
com.follow.clash.action.TOGGLE
|
||||
```
|
||||
|
||||
```bash
|
||||
dart setup.dart android
|
||||
```
|
||||
在电脑上也可以通过 adb 触发：
|
||||
|
||||
- windows
|
||||
```bash
|
||||
adb shell am start -a com.follow.clash.action.TOGGLE
|
||||
```
|
||||
|
||||
1. 你需要一个windows客户端
|
||||
## 从源码构建
|
||||
|
||||
2. 安装 `GCC`，`Inno Setup`
|
||||
需要 [Flutter](https://docs.flutter.dev/get-started/install) 3.47（正式版构建使用 3.47.4）、[Go](https://go.dev/dl/) 1.26，
|
||||
以及通过 rustup 安装的 [Rust](https://rustup.rs/)。桌面端需要在对应系统上构建，Android 在任意系统上都能构建。
|
||||
|
||||
3. 运行构建脚本
|
||||
```bash
|
||||
git clone --recursive https://github.com/chen08209/FlClash.git
|
||||
cd FlClash
|
||||
flutter pub get
|
||||
dart setup.dart android # 或 windows、macos、linux
|
||||
```
|
||||
|
||||
```bash
|
||||
dart setup.dart windows
|
||||
```
|
||||
安装包输出到 `dist/`。Go 内核和 Rust 库会在 Flutter 构建过程中一并编译。
|
||||
|
||||
- linux
|
||||
| 平台 | 额外依赖 |
|
||||
| --- | --- |
|
||||
| Android | 带 NDK 的 Android SDK。加上 `--arch arm64` 可以只构建单个 ABI。 |
|
||||
| Windows | 编译内核用的 GCC（MinGW-w64），以及打包安装程序用的 [Inno Setup](https://jrsoftware.org/isinfo.php) 6。 |
|
||||
| macOS | Xcode 与 Node.js。脚本会通过 npm 安装 `appdmg`。 |
|
||||
| Linux | Debian 或 Ubuntu。脚本会用 apt 安装构建所需的软件包，并下载 `appimagetool`。 |
|
||||
|
||||
1. 你需要一个linux客户端
|
||||
其余选项可以运行 `dart setup.dart --help` 查看，例如用 `--targets` 只构建部分安装包格式。
|
||||
|
||||
2. 依赖会由 setup 脚本自动安装，也可以手动安装：
|
||||
```bash
|
||||
sudo apt-get install -y libayatana-appindicator3-dev
|
||||
```
|
||||
## 支持
|
||||
|
||||
3. 运行构建脚本
|
||||
给仓库点一个 Star 是支持项目最简单的方式。问题讨论和更新通知请关注 [Telegram 频道](https://t.me/FlClash)，
|
||||
Bug 与功能建议请提交到 [GitHub Issues](https://github.com/chen08209/FlClash/issues)。
|
||||
|
||||
```bash
|
||||
dart setup.dart linux
|
||||
```
|
||||
<a href="https://star-history.com/#chen08209/FlClash&Date">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=chen08209/FlClash&type=Date&theme=dark">
|
||||
<img alt="Star history" src="https://api.star-history.com/svg?repos=chen08209/FlClash&type=Date" width="640">
|
||||
</picture>
|
||||
</a>
|
||||
|
||||
- macOS
|
||||
## 许可证
|
||||
|
||||
1. 你需要一个macOS客户端
|
||||
|
||||
2. 运行构建脚本
|
||||
|
||||
```bash
|
||||
dart setup.dart macos
|
||||
```
|
||||
|
||||
## Star
|
||||
|
||||
支持开发者的最简单方式是点击页面顶部的星标（⭐）。
|
||||
|
||||
<p style="text-align: center;">
|
||||
<a href="https://api.star-history.com/svg?repos=chen08209/FlClash&Date">
|
||||
<img alt="start" width=50% src="https://api.star-history.com/svg?repos=chen08209/FlClash&Date"/>
|
||||
</a>
|
||||
</p>
|
||||
FlClash 以 [GPL-3.0 协议](LICENSE)发布。
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 911 KiB After Width: | Height: | Size: 855 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 888 KiB After Width: | Height: | Size: 829 KiB |
Reference in New Issue
Block a user