docs: document monorepo layout

2026-07-20 10:53:10 +08:00
parent afdfa8bcf7
commit c4fd47e774
1 changed files with 9 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -1,5 +1,14 @@
 # 教学反馈助手小程序

+## Monorepo 结构
+
+本项目使用单一 Git 仓库管理小程序、Rust API 和中文转录服务。版本提交、分支和远程仓库都只在项目根目录维护，不要在子目录再次初始化 Git 仓库。
+
+- `pages/`、`utils/`：微信小程序界面与 API 客户端
+- `server/`：Rust API、数据库迁移与异步转录任务
+- `asr-service/`：基于 FunASR 的本地中文转录服务
+- `compose.asr.yml`：转录服务的容器编排配置
+
 ## 本地开发

 1. 确认微信开发者工具登录账号拥有 AppID `wx3fe11e262a4b4885` 对应小程序的开发权限。