Skip to content

Commit 50fe1c8

Browse files
committed
docs: 添加可执行文件打包说明文档
1 parent 0d39763 commit 50fe1c8

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

docs/EXECUTABLE_BUILD.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# 可执行文件打包和部署总结
2+
3+
## 完成内容
4+
5+
### 1. ✅ GitHub Actions 自动打包
6+
7+
**文件**: `.github/workflows/build-executables.yml`
8+
9+
**功能**:
10+
- 自动打包 Windows 和 Linux 可执行文件
11+
- 使用 PyInstaller 打包
12+
- 包含所有依赖和基础模型
13+
- 自动创建 Release 并上传文件
14+
15+
**触发条件**:
16+
- 推送 tag(如 `v1.0.0`
17+
- 手动触发(workflow_dispatch)
18+
19+
**输出文件**:
20+
- `AI-RVC-Windows-Portable.zip` - Windows 可执行文件
21+
- `AI-RVC-Linux-Portable.tar.gz` - Linux 可执行文件
22+
23+
### 2. ✅ PyInstaller 配置
24+
25+
**文件**: `AI-RVC.spec`
26+
27+
**配置内容**:
28+
- 打包所有必需的文件夹(ui、infer、lib、models、tools、i18n、configs)
29+
- 包含基础模型(HuBERT、RMVPE)
30+
- 隐藏导入所有依赖库
31+
- 收集 PyTorch、Gradio 等库的所有文件
32+
33+
### 3. ✅ Colab Notebook 优化
34+
35+
**文件**: `AI_RVC_Colab.ipynb`
36+
37+
**更新内容**:
38+
- 添加官方 Colab 平台链接按钮
39+
- 添加快速开始说明
40+
- 保持所有功能完整
41+
42+
**链接**: https://colab.research.google.com/github/mason369/AI-RVC/blob/master/AI_RVC_Colab.ipynb
43+
44+
### 4. ✅ README 文档更新
45+
46+
**更新内容**:
47+
- 新增 4 种使用方式(可执行文件、Colab、HF Spaces、本地安装)
48+
- 更新平台支持表格,添加安装方式列
49+
- 添加可执行文件下载和使用说明
50+
- 添加 Colab 官方链接按钮
51+
- 添加系统要求说明
52+
53+
## 如何创建 Release
54+
55+
### 推送 tag 触发自动打包
56+
57+
```bash
58+
# 1. 创建并推送 tag
59+
git tag -a v1.0.0 -m "Release v1.0.0: 首个可执行文件版本"
60+
git push origin v1.0.0
61+
62+
# 2. GitHub Actions 自动触发并创建 Release
63+
```
64+
65+
---
66+
67+
**更新日期**: 2026-03-10
68+
**状态**: ✅ 配置完成

0 commit comments

Comments
 (0)