为自建代码目录补齐 README,建立目录级导航体系

- 新增 26 份目录 README:App/(+log,task,util,protocol)、Drivers/BSP/(+8子系统)、
  Src/、Inc/、scripts/、tools/(+6子工具)、test/、MDK-ARM/、simulator/(+sim,tests)
- 每份含:定位、文件清单表、关键约束/陷阱、指向 docs 权威文档
- 第三方库与生成代码目录排除(CMSIS/HAL/Middlewares/Lib/SDL2)
- docs/文档规范.md 新增 §1.1b 代码目录 README 约定;根 README 目录结构加入说明
This commit is contained in:
2026-09-26 12:25:36 +08:00
parent 8d86fb1149
commit 39bd06adea
31 changed files with 1149 additions and 0 deletions
+44
View File
@@ -0,0 +1,44 @@
# tools/ — 开发工具
> 面向开发者的**功能性工具**(生成器 / 转换器 / 交互工具)。
> 与 `scripts/`(质量门禁与度量)分工不同:本目录产出**资产**(图、字体、代码、知识库)。
## 工具一览
| 目录 | 工具 | 产物 | 文档 |
|---|---|---|---|
| `arch_diagram/` | 架构图 SVG 生成器 | `docs/images/*.svg` | `docs/架构设计/图形绘制流程.md` |
| `font_gen/` | 中文字库生成 | `Drivers/BSP/UI/ui_font_cn_12.c` | `docs/UI设计/UI_中文字体生成与配置.md` |
| `menu_gen/` | 菜单树代码生成 | UI 菜单代码 | `docs/UI设计/菜单页面设计.md` |
| `netlist_semantics/` | 网表语义分析 | 引脚知识库 JSON + 网表报告 | `docs/硬件平台/` |
| `refgraph/` | 文件引用关系图 | `docs/images/引用关系图.*` | `docs/架构设计/引用关系图说明.md` |
| `serial_tool/` | Python 串口助手 | 日志状态(`state/`) | `docs/测试说明/串口助手使用指南.md` |
## 使用方式
```bash
# 架构图(精确布局)
& '.venv\Scripts\python.exe' tools/arch_diagram/gen_memory_svg.py
# 中文字体(含新汉字文案后必须重跑)
& '.venv\Scripts\python.exe' tools/font_gen/make_font.py
# 引用关系图
& 'tools\refgraph\gen_refgraph.bat'
# 串口助手(常驻 daemon)
& '.venv\Scripts\python.exe' tools/serial_tool/serial_tool.py
```
## ⚠️ 约定
- **生成器的产物与脚本一并提交**(如 SVG);本地预览产物(如 PNG)不提交
- 图表选型:精确布局图用 `arch_diagram/` 生成器;拓扑图(流程/时序/状态机)用 Mermaid;
**勿手绘 ASCII 框图**(见 `docs/架构设计/图形绘制流程.md`)
- 涉及 UI 改动:走 `ui-verify` skill 五步门禁;涉及字体:走 `font-regen` skill
## 相关文档
- `docs/架构设计/图形绘制流程.md` — 配图规范与选型
- `docs/架构设计/引用关系图说明.md`
- `docs/测试说明/串口助手使用指南.md`、`docs/测试说明/串口助手设计说明.md`