ReadMe主要包括哪些部分的内容:
国际化
项目简介
自述,对自己的项目进行简洁全面的概述,包括项目来源,项目主要内容,各个部分功能,项目完成主要针对的目标.
1.1 项目名称、logo(没有logo就不写)
1.2 这个开源项目是做什么的?
1.3 这个项目是什么语言编写的?功能特性
建议:静态的页面的放截图,交互很复杂的建议放gif图。 如果功能比较多,建议每个功能一张效果图项目基本结构
这里主要介绍项目的各个组成部分,如果是框架,可以附带架构图解;如果是其他的,可以提供一些UML分析图,顺便分析一下源码也行的。环境依赖
部署步骤
目录结构描述
版本内容更新
参考资料
声明
协议
- 参考