为自建代码目录补齐 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:
@@ -0,0 +1,28 @@
|
||||
# tools/menu_gen/ — 菜单代码生成
|
||||
|
||||
> 从**菜单树定义**生成 UI 菜单的 C 代码,保证菜单结构与页面注册一致、避免手写遗漏。
|
||||
|
||||
## 脚本一览
|
||||
|
||||
| 脚本 | 作用 |
|
||||
|---|---|
|
||||
| `gen_menu.py` | 读取菜单树定义(见 `ui_menu_tree.txt`)→ 生成菜单代码 |
|
||||
|
||||
## 使用方式
|
||||
|
||||
```bash
|
||||
& '.venv\Scripts\python.exe' tools/menu_gen/gen_menu.py
|
||||
```
|
||||
|
||||
菜单树输入的权威副本:仓库根 `ui_menu_tree.txt`。
|
||||
|
||||
## ⚠️ 注意
|
||||
|
||||
- 生成产物**勿手改**(会被下次生成覆盖);要改菜单结构改**定义源**后重跑
|
||||
- 中文字符串字面量须为**纯 ASCII 安全**(见 `AGENTS.md` 编码铁律)——生成后的文案
|
||||
如需汉字,须配套重跑字体生成(`tools/font_gen/`)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- `docs/UI设计/菜单页面设计.md`
|
||||
- `docs/UI设计/内容页架构.md`
|
||||
Reference in New Issue
Block a user