docs: 添加 main 分支索引

Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
2026-08-19 16:04:17 +08:00
co-authored by Cursor
commit 0eda925f58
3 changed files with 200 additions and 0 deletions
+64
View File
@@ -0,0 +1,64 @@
# soc-codegen-template
见宝科技 **SOC 代码生成模板仓库**。见宝工具箱生成/分发 SOC 工程时,从此仓库按分支拉取对应芯片模板。
**远程地址:** https://git.jianbao-tech.com/pets-device/soc-codegen-template.git
---
## 分支说明
本仓库 **`main` 分支仅作索引**,不含具体芯片工程。
每个 SOC 模板对应一个独立分支,命名规则:**`厂商-型号`**。
| 分支 | 说明 |
|------|------|
| **`main`** | 本页:分支索引与使用说明 |
| **`JieLi-JL7016`** | 杰理 JL7016 / AC7016CBR28)· 耳机 SDK + jb_protocol |
完整分支表见 [`docs/branch-index.md`](docs/branch-index.md)。
---
## 快速使用
```bash
# 克隆并切换到 JL7016 模板
git clone https://git.jianbao-tech.com/pets-device/soc-codegen-template.git
cd soc-codegen-template
git checkout JieLi-JL7016
```
切换后阅读该分支根目录 **`README.md`** 了解构建、OTA 配置与打包方式。
---
## 仓库结构(SOC 分支通用)
```text
<SOC分支>/
├── apps/ 应用(earphone / usr_jb_proto / usr_periph / usr_le_code
├── cpu/ 芯片平台代码与下载工具
├── include_lib/ SDK 头文件
├── tools/ 构建与打包脚本
├── Makefile 一键编译入口
└── *.cbp Code::Blocks 工程
```
> 各芯片目录细节以对应分支 README 为准。
---
## 维护者
- 新增 SOC:新建 `厂商-型号` 分支,更新 `docs/branch-index.md` 与本 README 表格
- 模板发版:在对应 SOC 分支打 tag,如 `JieLi-JL7016/v1.0.0`
---
## 相关链接
- [分支索引详情](docs/branch-index.md)
- [Gitea 仓库](https://git.jianbao-tech.com/pets-device/soc-codegen-template)
- [MCU 模板仓库](https://git.jianbao-tech.com/pets-device/mcu-codegen-template)