docs: add rules guide and shortcuts in main README

This commit is contained in:
袁震
2026-04-06 14:51:31 +08:00
parent d007cd11a5
commit 9594cf6387
2 changed files with 42 additions and 0 deletions
+8
View File
@@ -67,6 +67,14 @@ python3 src/rulegen.py --config configs/config.json --names Apple,YouTube
- `dist/clash/<Name>.yaml` - `dist/clash/<Name>.yaml`
- `dist/mihomo/<Name>.yaml` - `dist/mihomo/<Name>.yaml`
## 快捷方式
- 规则说明:`dist/README.md`
- Surge 目录:`dist/surge/`
- Loon 目录:`dist/loon/`
- Clash 目录:`dist/clash/`
- Mihomo 目录:`dist/mihomo/`
## 配置说明 ## 配置说明
默认配置:`configs/config.json` 默认配置:`configs/config.json`
+34
View File
@@ -0,0 +1,34 @@
# 规则说明
本目录提供可直接引用的分流规则文件。
## 目录
- `surge/`Surge 规则(`.list`
- `loon/`Loon 规则(`.list`
- `clash/`Clash Provider`.yaml`
- `mihomo/`Mihomo Provider`.yaml`
## 快速使用
仓库 Raw 基础地址:
- `https://git.halonice.com/yuanzhen869/shunt-rules/raw/branch/main/dist`
示例:
- Surge `Apple``https://git.halonice.com/yuanzhen869/shunt-rules/raw/branch/main/dist/surge/Apple.list`
- Loon `Apple``https://git.halonice.com/yuanzhen869/shunt-rules/raw/branch/main/dist/loon/Apple.list`
- Clash `Apple``https://git.halonice.com/yuanzhen869/shunt-rules/raw/branch/main/dist/clash/Apple.yaml`
- Mihomo `Apple``https://git.halonice.com/yuanzhen869/shunt-rules/raw/branch/main/dist/mihomo/Apple.yaml`
## 命名规则
- 文件名为分类名,如 `Apple``YouTube``OpenAI`
- Surge/Loon 后缀为 `.list`
- Clash/Mihomo 后缀为 `.yaml`
## 更新方式
- 由仓库工作流自动同步上游并生成。
-`main` 分支最新内容为准。