Skip to content

docs: 补充最小移植文件集与接入说明 #21

Description

@viys

背景

在完成目录结构拆分之后,仓库还需要一份面向使用者的“最小移植文件集说明”,否则新用户仍然需要自己判断:

  • 哪些文件必须带走
  • 哪些文件只是测试工程或仓库内辅助脚本
  • 头文件、源码文件、脚本、测试入口之间的依赖关系是什么

如果这部分不明确,即使目录结构变清晰,首次接入成本仍然偏高。

目标

作为 #19 的子任务,补充最小移植文件集与接入说明,帮助用户快速判断 CuTest 的最小集成范围。

范围

  • 明确最小移植文件集
  • 说明核心库文件、测试工程、脚本工具的职责边界
  • 说明哪些文件适合被业务项目直接引入
  • 说明哪些文件仅用于本仓库测试或辅助生成
  • 同步更新 README / 文档中的相关说明

验收标准

  • 文档中明确列出最小移植文件集
  • 文档能区分核心库、测试工程、脚本工具三类内容
  • 新用户不需要阅读整个仓库即可判断最小接入范围
  • 文档与实际目录结构保持一致

风险与注意事项

  • 若目录结构已调整,本文档必须与调整后的路径同步更新
  • 不应把仓库内部测试工程误写成业务项目必须携带的内容

关联

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions