仓库信息架构
mmwave monorepo 的目录层级、文档入口和内容放置规则
仓库信息架构
mmwave 不是单工程仓库,而是一个把硬件、实验、工具和结果集中在一起的 monorepo。理解它的最好方式,不是逐个文件夹硬看,而是先分清层级。
一级层级
projects/: 可直接运行、可产生实验数据的工程入口。当前主工程是 XY-FMCW。firmware/: 更靠近硬件侧的板级工程、参考工程和固件辅助工具。lab/: 小实验、课堂材料、配置样例和概念验证区。repro/: 论文复现和外部算法资料的落地目录。tools/: 桌面工具、上位机和提升联调效率的辅助项目。docs/: 统一的在线文档站,负责把上面这些内容组织成可浏览结构。
文档站对应关系
docs/firmware: 对应firmware/docs/lab: 对应lab/docs/projects: 对应projects/docs/reports: 汇总来自projects/*/captures的已验证实验结果docs/repro: 对应repro/docs/tools: 对应tools/
为什么要这样分
- 项目目录解决“怎么跑”。
- 固件目录解决“底层能力来自哪里”。
- lab 目录解决“怎么快速试想法”。
- repro 目录解决“外部资料如何落地到本仓库”。
- tools 目录解决“怎么把流程固化成可重复操作入口”。
- docs 则负责把这些层级解释清楚,避免仓库变成纯文件堆。
新内容应该放哪里
- 如果它能直接驱动采集、控制硬件或生成实验目录,优先放进
projects/。 - 如果它是硬件板级或设备固件,放进
firmware/。 - 如果它只是教学或概念验证脚本,放进
lab/。 - 如果它来自外部论文、仓库或算法迁移,放进
repro/。 - 如果它是配置器、运行器或桌面工具,放进
tools/。 - 如果它是结果说明、导航和说明文档,再落到
docs/。
实验结果入站规则
一个实验要进入 docs/reports,至少应满足:
- 有独立实验目录。
- 有 README 或等价说明文件。
- 有核心指标,比如分辨率、帧数、范围、扫描尺寸。
- 有至少一张可读预览图。
当前仓库的中心主线
当前最核心的运行链路仍然是 XY-FMCW:
- 24G 方向聚焦逐点扫描、实时预览和结构化落盘。
- 60G 方向聚焦 IWR6843 CLI 配置、TCP IQ 接收、自检和成像验证。
所以阅读顺序上,应始终优先理解 projects/XY-FMCW,其余目录大多是在支撑它。