前言
通过一段时间的查询和研究，总结了一下中小型项目的README.md文件的写法和规范。本篇文章包含README.md的源码和显示效果。
国际开源项目的README.md文件显示效果请见我的另一篇文章：链接。
README.md文件源码下载地址为：链接。（该链接还包含国际开源项目的通用README.md文件模板）
显示效果如下：
项目名称
目录
项目简介项目使用效果图安装说明使用说明目录结构关于作者贡献者/贡献组织鸣谢版权信息更新日志
项目简介
项目定位
项目特点
软件功能
版本信息
效果图
安装说明
环境依赖
node v0.10.28+
redIs ~
部署安装
添加系统环境变量 export $PORTAL_VERSION=“production” // production, test, dev
npm install //安装node运行环境
gulp build //前端编译
启动两个配置(已forever为例) eg: forever start app-service.js forever start logger-service.js
使用说明
简要说明
具体说明
目录结构
├── Readme.md // help
├── app // 应用
├── config // 配置
│ ├── default.json
│ ├── dev.json // 开发环境
│ ├── experiment.json // 实验
│ ├── index.js // 配置控制
│ ├── local.json // 本地
│ ├── production.json // 生产环境
│ └── test.json // 测试环境
├── data
├── doc // 文档
├── environment
├── gulpfile.js
├── locales
├── logger-service.js // 启动日志配置
├── node_modules
├── package.json
├── app-service.js // 启动应用配置
├── static // web静态资源加载
│ └── initjson
│ └── config.js // 提供给前端的配置
├── test
├── test-service.js
└── tools
关于作者
作者姓名
联系方式：电话或邮箱等
贡献者/贡献组织
请阅读 CONTRIBUTING.md 查阅为该项目做出贡献的开发者。
鸣谢
该项目参考了XXX的XXX
灵感来源于XXX
感谢XXX的支持和陪伴
版权信息
该项目签署了MIT 授权许可，详情请参阅 LICENSE.md
更新日志
V1.0.0 版本，yyyy-mm-dd
新功能：aaaaaaaaa新功能：bbbbbbbbb修改：ccccccccc修复：ddddddddd
V2.0.0 版本，yyyy-mm-dd
新功能：aaaaaaaaa新功能：bbbbbbbbb修改：ccccccccc修复：ddddddddd
