diff --git a/README.md b/README.md index 16ada8f..7c14f89 100644 --- a/README.md +++ b/README.md @@ -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/` 放构建排障过程中的原始文本记录。 diff --git a/3.txt b/docs/build-logs/3.txt similarity index 100% rename from 3.txt rename to docs/build-logs/3.txt diff --git a/emcc.txt b/docs/build-logs/emcc.txt similarity index 100% rename from emcc.txt rename to docs/build-logs/emcc.txt diff --git a/emcc20260116good.txt b/docs/build-logs/emcc20260116good.txt similarity index 100% rename from emcc20260116good.txt rename to docs/build-logs/emcc20260116good.txt diff --git a/emcc_debug.txt b/docs/build-logs/emcc_debug.txt similarity index 100% rename from emcc_debug.txt rename to docs/build-logs/emcc_debug.txt diff --git a/emcc_realase.txt b/docs/build-logs/emcc_realase.txt similarity index 100% rename from emcc_realase.txt rename to docs/build-logs/emcc_realase.txt diff --git a/emcc_test_20250116.txt b/docs/build-logs/emcc_test_20250116.txt similarity index 100% rename from emcc_test_20250116.txt rename to docs/build-logs/emcc_test_20250116.txt diff --git a/emmc_kdl.txt b/docs/build-logs/emmc_kdl.txt similarity index 100% rename from emmc_kdl.txt rename to docs/build-logs/emmc_kdl.txt diff --git a/kdl_wasm.txt b/docs/build-logs/kdl_wasm.txt similarity index 100% rename from kdl_wasm.txt rename to docs/build-logs/kdl_wasm.txt diff --git a/kdltes.txt b/docs/build-logs/kdltes.txt similarity index 100% rename from kdltes.txt rename to docs/build-logs/kdltes.txt diff --git a/t.txt b/docs/build-logs/t.txt similarity index 100% rename from t.txt rename to docs/build-logs/t.txt diff --git a/KDL求解.txt b/docs/notes/KDL求解.txt similarity index 100% rename from KDL求解.txt rename to docs/notes/KDL求解.txt diff --git a/项目功能.md b/docs/notes/项目功能.md similarity index 100% rename from 项目功能.md rename to docs/notes/项目功能.md diff --git a/debug.bat b/scripts/debug.bat similarity index 100% rename from debug.bat rename to scripts/debug.bat diff --git a/tests/README.md b/tests/README.md index f1c2b66..e2fb2d7 100644 --- a/tests/README.md +++ b/tests/README.md @@ -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. diff --git a/WorkTest.json b/tests/fixtures/legacy/WorkTest.json similarity index 100% rename from WorkTest.json rename to tests/fixtures/legacy/WorkTest.json diff --git a/par.json b/tests/fixtures/legacy/par.json similarity index 100% rename from par.json rename to tests/fixtures/legacy/par.json diff --git a/spc_in.txt b/tests/fixtures/legacy/spc_in.txt similarity index 100% rename from spc_in.txt rename to tests/fixtures/legacy/spc_in.txt diff --git a/spc_out.json b/tests/fixtures/legacy/spc_out.json similarity index 100% rename from spc_out.json rename to tests/fixtures/legacy/spc_out.json diff --git a/test.json b/tests/fixtures/legacy/test.json similarity index 100% rename from test.json rename to tests/fixtures/legacy/test.json