readme.md文件示例

一、readme文件包含内容

我们在项目中常常看到README.md 当然扩展名可能是txt ,rb,md ,甚至 me都有可能。README 应该是介绍code source 的一个概览，基本可以涵盖以下几部分内容：

引用块内容
你的项目介绍
你的代码实现了什么功能?
该如何使用? (系统环境参数,部署要素)
代码组织架构是什么样的?
版本更新重要摘要

---

二、demo

DEMO===========================###########环境依赖node v0.10.28+reids ~###########部署步骤1. 添加系统环境变量    export $PORTAL_VERSION="production" // production, test, dev2. npm install  //安装node运行环境3. gulp build   //前端编译4. 启动两个配置(已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###########V1.0.0 版本内容更新1. 新功能   aaaaaaaaa2. 新功能   bbbbbbbbb3. 新功能   ccccccccc4. 新功能   ddddddddd