规范模块目录和第三方依赖结构
This commit is contained in:
11
README.md
11
README.md
@@ -17,7 +17,7 @@
|
||||
```text
|
||||
.
|
||||
|-- src/ C++ 业务实现
|
||||
|-- inc/ 公共头文件
|
||||
|-- include/ 公共头文件和业务接口定义
|
||||
|-- scripts/ 构建、调试、回归测试脚本
|
||||
|-- tests/
|
||||
| |-- testdata/ 正式回归测试数据
|
||||
@@ -25,9 +25,12 @@
|
||||
|-- docs/
|
||||
| |-- notes/ 功能说明和算法笔记
|
||||
| `-- build-logs/ 历史编译记录和调试日志
|
||||
|-- third_party/
|
||||
| |-- eigen3/ 第三方 Eigen 依赖
|
||||
| |-- kdl_parser/ vendored URDF/KDL parser 源码
|
||||
| |-- nlohmann/ JSON 头文件库
|
||||
| `-- orocos_kdl/ 第三方 KDL 依赖及安装产物
|
||||
|-- public/wasm/ WASM 构建输出
|
||||
|-- Eigen3/ 第三方 Eigen 依赖
|
||||
|-- KDL/ 第三方 KDL 依赖及安装产物
|
||||
|-- package.json npm 入口
|
||||
|-- CMakeLists.txt CMake 入口
|
||||
`-- Makefile Make 入口
|
||||
@@ -44,6 +47,8 @@ npm run build-serve
|
||||
## 📁 目录约定
|
||||
|
||||
- 根目录只保留项目入口文件和核心目录,避免测试样例、日志、草稿散落在顶层。
|
||||
- `include/` 只放本项目对外和模块间共享的头文件。
|
||||
- `third_party/` 统一收纳所有外部依赖和 vendored 源码,避免和业务代码混放。
|
||||
- `tests/testdata/` 放可重复执行的标准化测试数据。
|
||||
- `tests/fixtures/legacy/` 放历史调试输入输出,便于追溯,但默认不作为正式回归入口。
|
||||
- `docs/notes/` 放业务说明和算法记录。
|
||||
|
||||
Reference in New Issue
Block a user