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
+74
View File
@@ -0,0 +1,74 @@
# =============================================================================
# 杰理 SOC 开发框架 — Git 忽略规则
# 原则:只跟踪源码/工程/厂商库与预置 blob/文档;编译产物与 IDE 个人配置不入库
# =============================================================================
# ── 编译输出目录 ───────────────────────────────────────────────────────────
objs/
# ── 链接 / 编译产物(按路径忽略,避免误伤厂商预置 blob)──────────────────
# 注意:不可全局忽略 *.bin
# cpu/*/tools/ 下 aac.bin / ota.bin / p11_code.bin / br28loader.bin / eq_*.bin 等必须入库
cpu/*/tools/sdk.elf
cpu/*/tools/sdk.elf.*
cpu/*/tools/sdk.map
cpu/*/tools/app.bin
cpu/*/sdk_used_list.used
cpu/*/tools/local.db
# LTO / LLVM 中间 bitcodesdk.elf.*.bc
*.bc
# ── 下载脚本生成的整包固件(密钥与 .bat 保留入库)────────────────────────
cpu/*/tools/download/**/*.fw
cpu/*/tools/download/**/*.ufw
cpu/*/tools/download/**/jl_isd.bin
cpu/*/tools/download/**/ota.bin
cpu/*/tools/download/**/update.*
cpu/*/tools/download/**/db_update_data.bin
cpu/*/tools/download/**/ipc_update_data*.bin
# ── 中间文件扩展名(散落于工程目录时兜底)────────────────────────────────
*.o
*.d
*.crf
*.axf
*.lnp
*.dep
*.map
*.elf
*.bak
# 不忽略 *.lstcpu/*/tools/rom.lst 为链接输入,必须入库
# ── 固件包(构建/打包生成,不入库)────────────────────────────────────────
*.hex
*.ufw
*.zip
# 不忽略 *.bin:厂商预置 bin 必须入库;应用产物仅按上方路径忽略 app.bin
# ── Code::Blocks 个人/本地 IDE 配置 ────────────────────────────────────────
# 注意:*.cbp 必须入库,不能 ignore
*.depend
*.layout
*.cbp.user
# ── 日志与临时文件 ─────────────────────────────────────────────────────────
Log/
*.log
# ── 编辑器 / Agent / Python ─────────────────────────────────────────────────
.vscode/
.cursor/
.idea/
*.swp
*~
__pycache__/
*.py[cod]
.Python
*.egg-info/
.eggs/
# ── OS 杂项 ─────────────────────────────────────────────────────────────────
Thumbs.db
Desktop.ini
.DS_Store
+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)
+62
View File
@@ -0,0 +1,62 @@
# SOC 代码生成模板 — 分支索引
本仓库按 **「厂商-型号」** 组织分支,每个分支是一套完整的 SOC 工程模板。
远程仓库:[soc-codegen-template](https://git.jianbao-tech.com/pets-device/soc-codegen-template)
---
## 分支列表
| 分支 | 厂商 | 型号 | 平台 | 默认能力 | 状态 |
|------|------|------|------|----------|------|
| [`JieLi-JL7016`](https://git.jianbao-tech.com/pets-device/soc-codegen-template/src/branch/JieLi-JL7016) | 杰理 JieLi | JL7016 / AC7016C | BR28 | 耳机 SDK + BLE + jb_protocol + OTA | ✅ 可用 |
> 新模板上线后在此表追加一行即可。
---
## 如何获取某 SOC 模板
### 见宝工具箱 / 自动化脚本
```bash
git clone https://git.jianbao-tech.com/pets-device/soc-codegen-template.git
cd soc-codegen-template
git checkout JieLi-JL7016
```
### 仅下载指定分支(浅克隆)
```bash
git clone --branch JieLi-JL7016 --single-branch \
https://git.jianbao-tech.com/pets-device/soc-codegen-template.git jl7016-template
```
---
## 分支命名规范
```
<厂商>-<型号>
```
示例:`JieLi-JL7016``JieLi-AC701N`
- 默认包含耳机应用与 jb_protocol,分支名**不加**多余后缀
- 同一芯片多种工程结构差异过大时,再考虑加后缀:`JieLi-JL7016-dongle`
---
## 新增 SOC 模板(维护者)
1.`main` 拉新分支:`git checkout -b <厂商>-<型号> main`
2. 合入该 SOC 完整工程(apps + cpu + include_lib + tools
3. 更新本文件分支表 + `main/README.md` 快速索引
4. 推送分支并在 Gitea 设为受保护分支(可选)
---
## 各分支 README
每个 SOC 分支根目录有独立的 `README.md`(构建、打包、协议对接说明)。