LinuxGUI自动化测试框架搭建（二十五）-框架README.md设计

（二十五）-框架README.md设计

• • 1 README作用
  • 2 如何写README
  • 3 框架结构完善
  • 4 完整的README文档
  • • 4.1 技术栈
    • 4.2 框架设计
    • 4.3 框架说明
    • 4.4 框架执行流程
    • 4.5 log日志
    • 4.6 测试报告html格式
    • 4.7 测试报告邮件格式
    • 4.8 执行方法

1 README作用

• 声明版权相关问题；
• 描述框架代码的作用；
• 告诉读者如何使用这个框架；
• 框架的基本操作过程等；
• 写框架的时候建议一定要有个README。

2 如何写README

思路如下：

• 版权声明
• 框架描述
• 代码结构
• 技术栈
• 框架设计
• 预期结