git工程README结构规范

目录

• 目录
• 0.基本信息
• 1.技术选型
• 2.项目目录说明
• 3.单页面模块说明
• 4.运行
• 5.打包
• 6.部署

0.基本信息

• 此处描述项目基本的接口文档链接以及其他依赖信息

1.技术选型

• 此处描述技术栈，并对每个类库描述对应的版本号

2.项目目录说明

• 此处对项目主要的目录进行简要描述

3.单页面模块说明

• 此处对单页面项目的主要模块进行简要描述

4.运行

• 此处描述可运行的命令

5.打包

• 此处描述不同环境打包方式

6.部署

• 此处描述不同环境的部署方式，特别是需要按不同开发者本地环境的差异进行调整的部分

---