整理项目目录结构

This commit is contained in:
zhangshun
2026-06-01 16:45:27 +08:00
parent ccfc17cee4
commit e8e485b115
20 changed files with 36 additions and 1 deletions

View File

@@ -13,3 +13,38 @@
-**完整错误处理** - 详细的错误信息和调试支持
## 🏗️ 项目结构
```text
.
|-- src/ C++ 业务实现
|-- inc/ 公共头文件
|-- scripts/ 构建、调试、回归测试脚本
|-- tests/
| |-- testdata/ 正式回归测试数据
| `-- fixtures/legacy/ 历史手工样例和原始参考数据
|-- docs/
| |-- notes/ 功能说明和算法笔记
| `-- build-logs/ 历史编译记录和调试日志
|-- public/wasm/ WASM 构建输出
|-- Eigen3/ 第三方 Eigen 依赖
|-- KDL/ 第三方 KDL 依赖及安装产物
|-- package.json npm 入口
|-- CMakeLists.txt CMake 入口
`-- Makefile Make 入口
```
## 📦 常用命令
```powershell
npm run build
npm run test:wasm
npm run build-serve
```
## 📁 目录约定
- 根目录只保留项目入口文件和核心目录,避免测试样例、日志、草稿散落在顶层。
- `tests/testdata/` 放可重复执行的标准化测试数据。
- `tests/fixtures/legacy/` 放历史调试输入输出,便于追溯,但默认不作为正式回归入口。
- `docs/notes/` 放业务说明和算法记录。
- `docs/build-logs/` 放构建排障过程中的原始文本记录。

View File

@@ -81,5 +81,5 @@ The runner is data-driven for stable request samples, and adds two dynamic FK/IK
## Notes
- The old ad-hoc files such as `spc_in.txt` and `WorkTest.json` are still useful as raw references, but the regression runner uses the normalized data under `tests/testdata`.
- The old ad-hoc files such as `tests/fixtures/legacy/spc_in.txt` and `tests/fixtures/legacy/WorkTest.json` are still useful as raw references, but the regression runner uses the normalized data under `tests/testdata`.
- If you change URDF, robot naming, or quadruped default config, update the corresponding files under `tests/testdata` first.