|
@@ -1,5 +1,59 @@
|
|
|
-# Clash Verge
|
|
|
+<h1 align="center">
|
|
|
+ <img src="./src/assets/image/logo.png" alt="Clash" width="128" />
|
|
|
+ <br>
|
|
|
+ Clash Verge
|
|
|
+ <br>
|
|
|
+</h1>
|
|
|
|
|
|
-work in progress...
|
|
|
+<h3 align="center">
|
|
|
+A <a href="https://github.com/Dreamacro/clash">Clash</a> GUI based on <a href="https://github.com/tauri-apps/tauri">tauri</a>.
|
|
|
+</h3>
|
|
|
|
|
|
-## Todo
|
|
|
+## Features
|
|
|
+
|
|
|
+Now it's no different from the others, even fewer. (WIP)
|
|
|
+
|
|
|
+## Development
|
|
|
+
|
|
|
+You should install Rust and Nodejs. Then install tauri cli and packages.
|
|
|
+
|
|
|
+```shell
|
|
|
+cargo install tauri-cli --git https://github.com/tauri-apps/tauri
|
|
|
+
|
|
|
+yarn install
|
|
|
+```
|
|
|
+
|
|
|
+Then download the clash binary... Or you can download it from [clash premium release](https://github.com/Dreamacro/clash/releases/tag/premium) and rename it according to [tauri config](https://tauri.studio/en/docs/api/config#tauri.bundle.externalBin).
|
|
|
+
|
|
|
+```shell
|
|
|
+yarn run predev
|
|
|
+```
|
|
|
+
|
|
|
+Then run
|
|
|
+
|
|
|
+```shell
|
|
|
+yarn dev
|
|
|
+```
|
|
|
+
|
|
|
+## Todos
|
|
|
+
|
|
|
+> This keng is a little big...
|
|
|
+
|
|
|
+## Screenshots
|
|
|
+
|
|
|
+<div align="center">
|
|
|
+ <img src="./docs/demo1.png" alt="demo1" width="42%" />
|
|
|
+ <img src="./docs/demo2.png" alt="demo2" width="42%" />
|
|
|
+</div>
|
|
|
+
|
|
|
+## Disclaimer
|
|
|
+
|
|
|
+This is a learning project for Rust practice.
|
|
|
+
|
|
|
+## Contributions
|
|
|
+
|
|
|
+PR welcome!
|
|
|
+
|
|
|
+## License
|
|
|
+
|
|
|
+GPL-3.0 License
|