docs: 添加 main 分支索引

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-08-18 18:59:34 +08:00
commit 9deadf2d77
3 changed files with 193 additions and 0 deletions
@@ -0,0 +1,61 @@
+# mcu-codegen-template
+
+见宝科技 **MCU 代码生成模板仓库**。见宝工具箱生成/分发 MCU 工程时，从此仓库按分支拉取对应芯片模板。
+
+**远程地址：** https://git.jianbao-tech.com/pets-device/mcu-codegen-template.git
+
+---
+
+## 分支说明
+
+本仓库 **`main` 分支仅作索引**，不含具体芯片工程。
+
+每个 MCU 模板对应一个独立分支，命名规则：**`厂商-型号`**（默认含 OTA）。
+
+| 分支 | 说明 |
+|------|------|
+| **`main`** | 本页：分支索引与使用说明 |
+| **`Puya-PY32F040`** | 普冉 PY32F040 · OTA 双工程框架（Bootloader + App + jb_protocol） |
+
+完整分支表见 [`docs/branch-index.md`](docs/branch-index.md)。
+
+---
+
+## 快速使用
+
+```bash
+# 克隆并切换到 PY32F040 模板
+git clone https://git.jianbao-tech.com/pets-device/mcu-codegen-template.git
+cd mcu-codegen-template
+git checkout Puya-PY32F040
+```
+
+切换后阅读该分支根目录 **`README.md`** 了解构建、OTA 配置与打包方式。
+
+---
+
+## 仓库结构（MCU 分支通用）
+
+```
+<MCU分支>/
+├── App/           APP Keil 工程
+├── Bootloader/    Bootloader Keil 工程
+├── Shared/        OTA 契约（ota_config.h 等，单一真源）
+├── Drivers/       厂商 HAL/CMSIS
+├── tools/         构建与打包脚本
+└── Doc/           设计文档
+```
+
+---
+
+## 维护者
+
+- 新增 MCU：新建 `厂商-型号` 分支，更新 `docs/branch-index.md` 与本 README 表格
+- 模板发版：在对应 MCU 分支打 tag，如 `Puya-PY32F040/v1.0.0`
+
+---
+
+## 相关链接
+
+- [分支索引详情](docs/branch-index.md)
+- [Gitea 仓库](https://git.jianbao-tech.com/pets-device/mcu-codegen-template)