<项目名称 Project Title>
一句话说明:这个项目解决什么问题?在 NEC 体系里属于哪条线(竞赛/科研/横向/工具)?
- 状态:🟢活跃 / 🟡开发中 / 🔴归档
- 负责人(Maintainer):@xxx
- 适合人群:新手 / 有基础 / 需要硬件 / 需要 ROS
- 预计上手时间:10min / 1h / 1d
1. 快速开始 Quickstart(必须能跑)
✅ 复制命令就能验证“项目是活的”
1.1 软件环境
- OS:Windows / macOS / Linux(支持情况)
- 依赖:Python / ROS2 / Docker / MCU Toolchain(写版本)
1.2 一键验证(最短路径)
2. 项目背景与目标
- 背景:为什么要做?
- 目标:做成什么样?
- 非目标:不做什么(防止范围膨胀)
3. 系统架构
- 架构图(图片或 ASCII)
- 模块划分(硬件/软件/算法/上位机/运营交付)
4. 目录结构说明
5. 硬件部分(如适用)
5.1 BOM
- 核心器件/替代器件/采购建议
5.2 接线/接口
- 接线图、供电注意、安全提示
6. 软件部分(如适用)
6.1 构建与运行
- 编译步骤、运行命令、参数说明
6.2 调试与日志
- 日志开关、常见报错排查
7. 交付物
- ✅ 代码 / CAD / 图纸 / 报告 / 视频 / 可复现实验
8. Roadmap
- M1(截止日期)
- M2
- M3
9. 如何贡献
good first issue列表链接- 贡献规范:
CONTRIBUTING.md - 建议新人改动的入口(路径/模块)
10. License & Acknowledgments
- 许可证
- 鸣谢(引用资料/开源项目/赞助支持)