From 8ebf91533021ef288ea6ec557e4d6b360224f7e0 Mon Sep 17 00:00:00 2001 From: Slinetrac Date: Mon, 20 Oct 2025 15:56:38 +0800 Subject: [PATCH] docs: README.md i18n --- README.md | 11 ++- docs/README_en.md | 124 ++++++++++++++++++++++++++++++ docs/README_es.md | 124 ++++++++++++++++++++++++++++++ docs/README_ja.md | 124 ++++++++++++++++++++++++++++++ README_ru.md => docs/README_ru.md | 34 ++++---- 5 files changed, 401 insertions(+), 16 deletions(-) create mode 100644 docs/README_en.md create mode 100644 docs/README_es.md create mode 100644 docs/README_ja.md rename README_ru.md => docs/README_ru.md (80%) diff --git a/README.md b/README.md index ea356831..04147c5d 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,15 @@ A Clash Meta GUI based on Tauri. -[![中文](https://img.shields.io/badge/lang-中文-red.svg)](README.md) -[![Russian](https://img.shields.io/badge/lang-Rus-blue.svg)](README_ru.md) +

+ Languages: + 简体中文 · + English · + Español · + Русский · + 日本語 +

+ ## Preview | Dark | Light | diff --git a/docs/README_en.md b/docs/README_en.md new file mode 100644 index 00000000..cc1762f7 --- /dev/null +++ b/docs/README_en.md @@ -0,0 +1,124 @@ +

+ Clash +
+ Continuation of Clash Verge +
+

+ +

+A Clash Meta GUI built with Tauri. +

+ +

+ Languages: + 简体中文 · + English · + Español · + Русский · + 日本語 +

+ +## Preview + +| Dark | Light | +| ----------------------------------- | ------------------------------------- | +| ![Dark Preview](./preview_dark.png) | ![Light Preview](./preview_light.png) | + +## Install + +Visit the [Release page](https://github.com/clash-verge-rev/clash-verge-rev/releases) to download the installer that matches your platform.
+We provide packages for Windows (x64/x86), Linux (x64/arm64), and macOS 10.15+ (Intel/Apple). + +#### Choosing a Release Channel + +| Channel | Description | Link | +| :---------- | :-------------------------------------------------------------------- | :------------------------------------------------------------------------------------- | +| Stable | Official builds with high reliability, ideal for daily use. | [Release](https://github.com/clash-verge-rev/clash-verge-rev/releases) | +| Alpha (EOL) | Legacy builds used to validate the publish pipeline. | [Alpha](https://github.com/clash-verge-rev/clash-verge-rev/releases/tag/alpha) | +| AutoBuild | Rolling builds for testing and feedback. Expect experimental changes. | [AutoBuild](https://github.com/clash-verge-rev/clash-verge-rev/releases/tag/autobuild) | + +#### Installation Guides & FAQ + +Read the [project documentation](https://clash-verge-rev.github.io/) for install steps, troubleshooting, and frequently asked questions. + +--- + +### Telegram Channel + +Join [@clash_verge_rev](https://t.me/clash_verge_re) for update announcements. + +## Promotion + +#### [Doggygo VPN — Performance-oriented global accelerator](https://verge.dginv.click/#/register?code=oaxsAGo6) + +- High-performance overseas network service with free trials, discounted plans, streaming unlocks, and first-class Hysteria protocol support. +- Register through the exclusive Clash Verge link to get a 3-day trial with 1 GB of traffic per day: [Sign up](https://verge.dginv.click/#/register?code=oaxsAGo6) +- Exclusive 20% off coupon for Clash Verge users: `verge20` (limited to 500 uses) +- Discounted bundle from ¥15.8 per month for 160 GB, plus an additional 20% off for yearly billing +- Operated by an overseas team with reliable service and up to 50% revenue share +- Load-balanced clusters with high-speed dedicated routes (compatible with legacy clients), exceptionally low latency, smooth 4K playback +- First global provider to support the `Hysteria2` protocol—perfect fit for the Clash Verge client +- Supports streaming services and ChatGPT access +- Official site: [https://狗狗加速.com](https://verge.dginv.click/#/register?code=oaxsAGo6) + +#### Build Infrastructure Sponsor — [YXVM Dedicated Servers](https://yxvm.com/aff.php?aff=827) + +Our builds and releases run on YXVM dedicated servers that deliver premium resources, strong performance, and high-speed networking. If downloads feel fast and usage feels snappy, it is thanks to robust hardware. + +🧩 Highlights of YXVM Dedicated Servers: + +- 🌎 Optimized global routes for dramatically faster downloads +- 🔧 Bare-metal resources instead of shared VPS capacity for maximum performance +- 🧠 Great for proxy workloads, hosting web/CDN services, CI/CD pipelines, or any high-load tasks +- 💡 Ready to use instantly with multiple datacenter options, including CN2 and IEPL +- 📦 The configuration used by this project is on sale—feel free to get the same setup +- 🎯 Want the same build environment? [Order a YXVM server today](https://yxvm.com/aff.php?aff=827) + +## Features + +- Built on high-performance Rust with the Tauri 2 framework +- Ships with the embedded [Clash.Meta (mihomo)](https://github.com/MetaCubeX/mihomo) core and supports switching to the `Alpha` channel +- Clean, polished UI with theme color controls, proxy group/tray icons, and `CSS Injection` +- Enhanced profile management (Merge and Script helpers) with configuration syntax hints +- System proxy controls, guard mode, and `TUN` (virtual network adapter) support +- Visual editors for nodes and rules +- WebDAV-based backup and sync for configurations + +### FAQ + +See the [FAQ page](https://clash-verge-rev.github.io/faq/windows.html) for platform-specific guidance. + +### Donation + +[Support Clash Verge Rev development](https://github.com/sponsors/clash-verge-rev) + +## Development + +See [CONTRIBUTING.md](../CONTRIBUTING.md) for detailed contribution guidelines. + +After installing all **Tauri** prerequisites, run the development shell with: + +```shell +pnpm i +pnpm run prebuild +pnpm dev +``` + +## Contributions + +Issues and pull requests are welcome! + +## Acknowledgement + +Clash Verge Rev builds on or draws inspiration from these projects: + +- [zzzgydi/clash-verge](https://github.com/zzzgydi/clash-verge): A Tauri-based Clash GUI for Windows, macOS, and Linux. +- [tauri-apps/tauri](https://github.com/tauri-apps/tauri): Build smaller, faster, more secure desktop apps with a web frontend. +- [Dreamacro/clash](https://github.com/Dreamacro/clash): A rule-based tunnel written in Go. +- [MetaCubeX/mihomo](https://github.com/MetaCubeX/mihomo): A rule-based tunnel written in Go. +- [Fndroid/clash_for_windows_pkg](https://github.com/Fndroid/clash_for_windows_pkg): A Clash GUI for Windows and macOS. +- [vitejs/vite](https://github.com/vitejs/vite): Next-generation frontend tooling with blazing-fast DX. + +## License + +GPL-3.0 License. See the [license file](../LICENSE) for details. diff --git a/docs/README_es.md b/docs/README_es.md new file mode 100644 index 00000000..f8760092 --- /dev/null +++ b/docs/README_es.md @@ -0,0 +1,124 @@ +

+ Clash +
+ Continuación de Clash Verge +
+

+ +

+Una interfaz gráfica para Clash Meta construida con Tauri. +

+ +

+ Idiomas: + 简体中文 · + English · + Español · + Русский · + 日本語 +

+ +## Vista previa + +| Oscuro | Claro | +| ----------------------------------- | ----------------------------------- | +| ![Vista oscura](./preview_dark.png) | ![Vista clara](./preview_light.png) | + +## Instalación + +Visita la [página de lanzamientos](https://github.com/clash-verge-rev/clash-verge-rev/releases) y descarga el instalador que corresponda a tu plataforma.
+Ofrecemos paquetes para Windows (x64/x86), Linux (x64/arm64) y macOS 10.15+ (Intel/Apple). + +#### Cómo elegir el canal de lanzamiento + +| Canal | Descripción | Enlace | +| :---------- | :----------------------------------------------------------------------------- | :------------------------------------------------------------------------------------- | +| Stable | Compilaciones oficiales de alta fiabilidad; ideales para el uso diario. | [Release](https://github.com/clash-verge-rev/clash-verge-rev/releases) | +| Alpha (EOL) | Compilaciones heredadas usadas para validar el flujo de publicación. | [Alpha](https://github.com/clash-verge-rev/clash-verge-rev/releases/tag/alpha) | +| AutoBuild | Compilaciones continuas para pruebas y retroalimentación. Espera cambios beta. | [AutoBuild](https://github.com/clash-verge-rev/clash-verge-rev/releases/tag/autobuild) | + +#### Guías de instalación y preguntas frecuentes + +Consulta la [documentación del proyecto](https://clash-verge-rev.github.io/) para encontrar los pasos de instalación, solución de problemas y preguntas frecuentes. + +--- + +### Canal de Telegram + +Únete a [@clash_verge_rev](https://t.me/clash_verge_re) para enterarte de las novedades. + +## Promociones + +#### [Doggygo VPN — Acelerador global orientado al rendimiento](https://verge.dginv.click/#/register?code=oaxsAGo6) + +- Servicio internacional de alto rendimiento con prueba gratuita, planes con descuento, desbloqueo de streaming y soporte de protocolo Hysteria de primera clase. +- Regístrate mediante el enlace exclusivo de Clash Verge y obtén una prueba de 3 días con 1 GB de tráfico diario: [Regístrate](https://verge.dginv.click/#/register?code=oaxsAGo6) +- Cupón exclusivo de 20% de descuento para usuarios de Clash Verge: `verge20` (limitado a 500 usos) +- Plan promocional desde ¥15.8 al mes con 160 GB, más 20% de descuento adicional por pago anual +- Equipo ubicado en el extranjero para un servicio confiable, con hasta 50% de comisión compartida +- Clústeres balanceados con rutas dedicadas de alta velocidad (compatibles con clientes antiguos), latencia extremadamente baja, reproducción 4K sin interrupciones +- Primer proveedor global que soporta el protocolo `Hysteria2`, ideal para el cliente Clash Verge +- Desbloquea servicios de streaming y acceso a ChatGPT +- Sitio oficial: [https://狗狗加速.com](https://verge.dginv.click/#/register?code=oaxsAGo6) + +#### Patrocinador de la infraestructura de compilación — [Servidores dedicados YXVM](https://yxvm.com/aff.php?aff=827) + +Las compilaciones y lanzamientos del proyecto se ejecutan en servidores dedicados de YXVM, que proporcionan recursos premium, alto rendimiento y redes de alta velocidad. Si las descargas son rápidas y el uso es fluido, es gracias a este hardware robusto. + +🧩 Ventajas de los servidores dedicados YXVM: + +- 🌎 Rutas globales optimizadas para descargas significativamente más rápidas +- 🔧 Recursos bare-metal, en lugar de VPS compartidos, para obtener el máximo rendimiento +- 🧠 Ideales para proxys, alojamiento de sitios web/CDN, pipelines de CI/CD o cualquier carga elevada +- 💡 Listos para usar al instante, con múltiples centros de datos disponibles (incluidos CN2 e IEPL) +- 📦 La misma configuración utilizada por este proyecto está disponible para su compra +- 🎯 ¿Quieres el mismo entorno de compilación? [Solicita un servidor YXVM hoy](https://yxvm.com/aff.php?aff=827) + +## Funciones + +- Basado en Rust de alto rendimiento y en el framework Tauri 2 +- Incluye el núcleo integrado [Clash.Meta (mihomo)](https://github.com/MetaCubeX/mihomo) y permite cambiar al canal `Alpha` +- Interfaz limpia y elegante con controles de color de tema, iconos de grupos proxy/bandeja y `CSS Injection` +- Gestión avanzada de perfiles (herramientas Merge y Script) con sugerencias de sintaxis para configuraciones +- Control del proxy del sistema, modo guardián y soporte para `TUN` (adaptador de red virtual) +- Editores visuales para nodos y reglas +- Copias de seguridad y sincronización mediante WebDAV + +### Preguntas frecuentes + +Visita la [página de FAQ](https://clash-verge-rev.github.io/faq/windows.html) para obtener instrucciones específicas por plataforma. + +### Donaciones + +[Apoya el desarrollo de Clash Verge Rev](https://github.com/sponsors/clash-verge-rev) + +## Desarrollo + +Consulta [CONTRIBUTING.md](../CONTRIBUTING.md) para conocer las pautas de contribución. + +Después de instalar todos los requisitos de **Tauri**, ejecuta el entorno de desarrollo con: + +```shell +pnpm i +pnpm run prebuild +pnpm dev +``` + +## Contribuciones + +Se agradecen los issues y pull requests. + +## Agradecimientos + +Clash Verge Rev se basa en, o se inspira en, los siguientes proyectos: + +- [zzzgydi/clash-verge](https://github.com/zzzgydi/clash-verge): Interfaz gráfica para Clash basada en Tauri. Compatible con Windows, macOS y Linux. +- [tauri-apps/tauri](https://github.com/tauri-apps/tauri): Construye aplicaciones de escritorio más pequeñas, rápidas y seguras con un frontend web. +- [Dreamacro/clash](https://github.com/Dreamacro/clash): Túnel basado en reglas escrito en Go. +- [MetaCubeX/mihomo](https://github.com/MetaCubeX/mihomo): Túnel basado en reglas escrito en Go. +- [Fndroid/clash_for_windows_pkg](https://github.com/Fndroid/clash_for_windows_pkg): Interfaz de Clash para Windows y macOS. +- [vitejs/vite](https://github.com/vitejs/vite): Herramientas de frontend de nueva generación con una experiencia rapidísima. + +## Licencia + +Licencia GPL-3.0. Consulta el [archivo de licencia](../LICENSE) para más detalles. diff --git a/docs/README_ja.md b/docs/README_ja.md new file mode 100644 index 00000000..c2ed71e2 --- /dev/null +++ b/docs/README_ja.md @@ -0,0 +1,124 @@ +

+ Clash +
+ Clash Verge の継続プロジェクト +
+

+ +

+Tauri で構築された Clash Meta GUI。 +

+ +

+ 言語: + 简体中文 · + English · + Español · + Русский · + 日本語 +

+ +## プレビュー + +| ダーク | ライト | +| --------------------------------------- | ---------------------------------------- | +| ![ダークプレビュー](./preview_dark.png) | ![ライトプレビュー](./preview_light.png) | + +## インストール + +[リリースページ](https://github.com/clash-verge-rev/clash-verge-rev/releases) から、ご利用のプラットフォームに対応したインストーラーをダウンロードしてください。
+Windows (x64/x86)、Linux (x64/arm64)、macOS 10.15+ (Intel/Apple) をサポートしています。 + +#### リリースチャンネルの選び方 + +| チャンネル | 説明 | リンク | +| :---------- | :--------------------------------------------------------------- | :------------------------------------------------------------------------------------- | +| Stable | 安定版。信頼性が高く、日常利用に最適です。 | [Release](https://github.com/clash-verge-rev/clash-verge-rev/releases) | +| Alpha (EOL) | 公開フローの検証に使用した旧テスト版。 | [Alpha](https://github.com/clash-verge-rev/clash-verge-rev/releases/tag/alpha) | +| AutoBuild | 継続的に更新されるテスト版。フィードバックや新機能検証向けです。 | [AutoBuild](https://github.com/clash-verge-rev/clash-verge-rev/releases/tag/autobuild) | + +#### インストール手順と FAQ + +詳しい導入手順やトラブルシュートは [ドキュメントサイト](https://clash-verge-rev.github.io/) を参照してください。 + +--- + +### Telegram チャンネル + +更新情報は [@clash_verge_rev](https://t.me/clash_verge_re) をフォローしてください。 + +## プロモーション + +#### [Doggygo VPN — 高性能グローバルアクセラレータ](https://verge.dginv.click/#/register?code=oaxsAGo6) + +- 無料トライアル、割引プラン、ストリーミング解放、世界初の Hysteria プロトコル対応を備えた高性能海外ネットワークサービス。 +- Clash Verge 専用リンクから登録すると、3 日間・1 日 1 GB の無料体験が利用できます。 [登録はこちら](https://verge.dginv.click/#/register?code=oaxsAGo6) +- Clash Verge 利用者限定 20% オフクーポン: `verge20`（先着 500 名） +- 月額 15.8 元で 160 GB を利用できるプラン、年額契約ならさらに 20% オフ +- 海外チーム運営による高信頼サービス、収益シェアは最大 50% +- 負荷分散クラスタと高速専用回線（旧クライアント互換）、極低レイテンシで 4K も快適 +- 世界初の `Hysteria2` プロトコル対応。Clash Verge クライアントとの相性抜群 +- ストリーミングおよび ChatGPT の利用にも対応 +- 公式サイト: [https://狗狗加速.com](https://verge.dginv.click/#/register?code=oaxsAGo6) + +#### ビルド環境スポンサー — [YXVM 専用サーバー](https://yxvm.com/aff.php?aff=827) + +本プロジェクトのビルドとリリースは、YXVM の専用サーバーによって支えられています。高速ダウンロードや快適な操作性は、強力なハードウェアがあってこそです。 + +🧩 YXVM 専用サーバーの特長: + +- 🌎 最適化されたグローバル回線で圧倒的なダウンロード速度 +- 🔧 VPS とは異なるベアメタル資源で最高性能を発揮 +- 🧠 プロキシ運用、Web/CDN ホスティング、CI/CD など高負荷ワークロードに最適 +- 💡 複数データセンターから即時利用可能。CN2 や IEPL も選択可 +- 📦 本プロジェクトが使用している構成も販売中。同じ環境を入手できます +- 🎯 同じビルド体験をしたい方は [今すぐ YXVM サーバーを注文](https://yxvm.com/aff.php?aff=827) + +## 機能 + +- 高性能な Rust と Tauri 2 フレームワークに基づくデスクトップアプリ +- 組み込みの [Clash.Meta (mihomo)](https://github.com/MetaCubeX/mihomo) コアを搭載し、`Alpha` チャンネルへの切り替えも可能 +- テーマカラーやプロキシグループ／トレイアイコン、`CSS Injection` をカスタマイズできる洗練された UI +- 設定ファイルの管理および拡張（Merge・Script 支援）、構成シンタックスヒントを提供 +- システムプロキシ制御、ガード機能、`TUN`（仮想ネットワークアダプタ）モード +- ノードとルールのビジュアルエディタ +- WebDAV による設定のバックアップと同期 + +### FAQ + +プラットフォーム別の案内は [FAQ ページ](https://clash-verge-rev.github.io/faq/windows.html) を参照してください。 + +### 寄付 + +[Clash Verge Rev の開発を支援する](https://github.com/sponsors/clash-verge-rev) + +## 開発 + +詳細な貢献ガイドは [CONTRIBUTING.md](../CONTRIBUTING.md) をご覧ください。 + +**Tauri** の前提条件を整えたら、以下のコマンドで開発サーバーを起動できます: + +```shell +pnpm i +pnpm run prebuild +pnpm dev +``` + +## コントリビューション + +Issue や Pull Request を歓迎します。 + +## 謝辞 + +Clash Verge Rev は、以下のプロジェクトに影響を受けています。 + +- [zzzgydi/clash-verge](https://github.com/zzzgydi/clash-verge): Tauri ベースの Clash GUI。Windows / macOS / Linux に対応。 +- [tauri-apps/tauri](https://github.com/tauri-apps/tauri): Web フロントエンドで小型・高速・安全なデスクトップアプリを構築するためのフレームワーク。 +- [Dreamacro/clash](https://github.com/Dreamacro/clash): Go 製のルールベーストンネル。 +- [MetaCubeX/mihomo](https://github.com/MetaCubeX/mihomo): Go 製のルールベーストンネル。 +- [Fndroid/clash_for_windows_pkg](https://github.com/Fndroid/clash_for_windows_pkg): Windows / macOS 向けの Clash GUI。 +- [vitejs/vite](https://github.com/vitejs/vite): 次世代のフロントエンドツール群。高速な開発体験を提供。 + +## ライセンス + +GPL-3.0 ライセンス。詳細は [LICENSE](../LICENSE) を参照してください。 diff --git a/README_ru.md b/docs/README_ru.md similarity index 80% rename from README_ru.md rename to docs/README_ru.md index 25f8bcfe..f01bf7e8 100644 --- a/README_ru.md +++ b/docs/README_ru.md @@ -1,5 +1,5 @@

- Clash + Clash
Continuation of Clash Verge
@@ -9,13 +9,19 @@ Clash Meta GUI базируется на Tauri.

-[![中文](https://img.shields.io/badge/lang-中文-red.svg)](README.md) -[![Russian](https://img.shields.io/badge/lang-Rus-blue.svg)](README_ru.md) +

+ Языки: + 简体中文 · + English · + Español · + Русский · + 日本語 +

## Предпросмотр -| Тёмная тема | Светлая тема | -| -------------------------------- | --------------------------------- | -| ![Тёмная тема](./docs/preview_dark.png) | ![Светлая тема](./docs/preview_light.png) | +| Тёмная тема | Светлая тема | +| ---------------------------------- | ------------------------------------ | +| ![Тёмная тема](./preview_dark.png) | ![Светлая тема](./preview_light.png) | ## Установка @@ -25,11 +31,11 @@ Clash Meta GUI базируется на