From 050d3f5d63ae5a4a9d0fc3028f62215215b98dab Mon Sep 17 00:00:00 2001 From: fengfeng-zi Date: Fri, 1 May 2026 19:05:39 +0800 Subject: [PATCH 1/3] docs: clarify releases README scope --- releases/README.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/releases/README.md b/releases/README.md index 8c72f9d..0fcf3e1 100644 --- a/releases/README.md +++ b/releases/README.md @@ -1,25 +1,28 @@ # Releases -## 这个目录是什么 +## 这个目录是什么？ -发布说明与占位目录。 +发布说明与发布边界的占位入口目录。 -## 当前包含什么 +## 当前包含什么？ -- 当前仅保留 README，占位使用。 +- 当前只保留本 README，作为发布约定入口 +- 更完整的发布原则、发布物范围和仓库边界说明见 [`docs/releases.md`](../docs/releases.md) -## 当前不包含什么 +## 当前不包含什么？ - `exe` - `msi` - `dmg` -- 打包目录 +- 发布压缩包 +- 打包输出目录 - 任何安装包二进制 -## 如何构建 +## 如何使用这个目录 -当前无独立构建内容。 +当前不要把安装包、构建产物或本地打包缓存提交到这里。 +如果需要更新发布约定，请优先修改 [`docs/releases.md`](../docs/releases.md)，再视情况同步这里的简要说明。 ## GitHub Releases 对应发布物 -真正的安装包与发布二进制应上传到 GitHub Releases，而不是保存在本目录中。 +真正的安装包与发布二进制应上传到 GitHub Releases，而不是保存在本目录或源码仓库中。 From 0f9af8c137aaf3d73f8d47b206af7df6dcf7f7ce Mon Sep 17 00:00:00 2001 From: fengfeng-zi Date: Fri, 1 May 2026 19:06:45 +0800 Subject: [PATCH 2/3] docs: clarify releases README --- releases/README.md | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/releases/README.md b/releases/README.md index 0fcf3e1..047cd66 100644 --- a/releases/README.md +++ b/releases/README.md @@ -1,28 +1,31 @@ # Releases -## 这个目录是什么？ +## 这个目录是什么 -发布说明与发布边界的占位入口目录。 +发布相关约定与入口说明目录。 +这个目录本身不是二进制产物的存放位置。 -## 当前包含什么？ +## 当前包含什么 -- 当前只保留本 README，作为发布约定入口 -- 更完整的发布原则、发布物范围和仓库边界说明见 [`docs/releases.md`](../docs/releases.md) +- 当前仅保留 `README.md` 作为入口说明 +- 更完整的发布约定请查看 [`docs/releases.md`](../docs/releases.md) -## 当前不包含什么？ +## 当前不包含什么 - `exe` - `msi` - `dmg` -- 发布压缩包 -- 打包输出目录 +- `zip` +- 打包缓存或本地组装目录 - 任何安装包二进制 +- 私钥、签名文件、token 或其他 secrets -## 如何使用这个目录 +## 如何构建 -当前不要把安装包、构建产物或本地打包缓存提交到这里。 -如果需要更新发布约定，请优先修改 [`docs/releases.md`](../docs/releases.md)，再视情况同步这里的简要说明。 +当前目录不提供独立构建入口。 +平台源码、脚本和构建细节应分别查看对应平台子目录与文档。 ## GitHub Releases 对应发布物 -真正的安装包与发布二进制应上传到 GitHub Releases，而不是保存在本目录或源码仓库中。 +真正的安装包与发布二进制应上传到 GitHub Releases， +而不是提交到仓库中的 `releases/` 目录。 From ccdbf089e358014c896c691990aa7dd242be403e Mon Sep 17 00:00:00 2001 From: fengfeng-zi Date: Fri, 1 May 2026 19:08:49 +0800 Subject: [PATCH 3/3] docs: link vibe config tool packaging guide --- .../windows/desktop-main/vibe_code_config_tool/readme.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/platforms/windows/desktop-main/vibe_code_config_tool/readme.md b/platforms/windows/desktop-main/vibe_code_config_tool/readme.md index 435863f..1af7d3b 100644 --- a/platforms/windows/desktop-main/vibe_code_config_tool/readme.md +++ b/platforms/windows/desktop-main/vibe_code_config_tool/readme.md @@ -1,5 +1,12 @@ # vibe_code_config_tool +## 相关文档 + +- 打包与 PyInstaller 说明请见 `BUILD.md` +- `dist/` 目录中的产物属于本地构建输出或发布产物，不应直接提交到仓库 +- 若需要面对最终用户分发安装包，请优先走仓库约定的 GitHub Releases 流程 + + ## 模块简介 `vibe_code_config_tool` 是用户侧主桌面程序，负责连接键盘设备、编辑按键和动画配置、查看设备信息、处理用户账号与订阅操作，并可一键启动本地语音服务 `Capswriter`。