66 lines
2.1 KiB
Markdown
66 lines
2.1 KiB
Markdown
# mcu-codegen-template
|
||
|
||
见宝科技 **MCU 代码生成模板仓库**。见宝工具箱生成/分发 MCU 工程时，从此仓库按分支拉取对应芯片模板。
|
||
|
||
**主仓库（见宝 Git）：** <https://git.jianbao-tech.com/pets-device/mcu-codegen-template.git>
|
||
**码云镜像（推荐下载）：** <https://gitee.com/wu-chuyuan/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://gitee.com/wu-chuyuan/mcu-codegen-template.git
|
||
cd mcu-codegen-template
|
||
git checkout Puya-PY32F040
|
||
```
|
||
|
||
切换后阅读该分支根目录 **`README.md`** 了解构建、OTA 配置与打包方式。
|
||
|
||
---
|
||
|
||
## 仓库结构（MCU 分支通用）
|
||
|
||
```text
|
||
<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`
|
||
- 推送：本地 `origin` 已配置双写，`git push origin` 会同时推到见宝 Git 与码云镜像
|
||
|
||
---
|
||
|
||
## 相关链接
|
||
|
||
- [分支索引详情](docs/branch-index.md)
|
||
- [码云镜像（推荐下载）](https://gitee.com/wu-chuyuan/mcu-codegen-template)
|
||
- [见宝 Git 主仓库](https://git.jianbao-tech.com/pets-device/mcu-codegen-template)
|
||
- [SOC 模板仓库](https://git.jianbao-tech.com/pets-device/soc-codegen-template)
|