README规范总结

目录

1.为什么要写README文件？

2.DEMO

三、MarkDown部分语法

3.1.标题

3.2列表

3.3引用

3.4粗体和斜体

3.5链接与图片

3.6分割线

3.7表格

3.8代码高亮

3.9制作代办事项To-do List

3.10高效绘制流程图，序列图，甘特图，表格

3.11书写数学公式

---

github，oschina git gitcafe的代码托管平台上的项目的Readme.MD文件都是有其特有的语法的。称之为Markdown语法。内容参照https://www.cnblogs.com/wj-1314/p/8547763.html编写，如有侵权请及时联系。

一、为什么要写README文件？

对于这个问题详解，请看：http://www.cnblogs.com/wj-1314/p/7551184.html

二、DEMO

DEMO
===========================

###########环境依赖
node v0.10.28+
redIs ~

###########部署步骤
1. 添加系统环境变量
    export $PORTAL_VERSION="production" // production, test, dev


2. 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. 新功能     aaaaaaaaa
2. 新功能     bbbbbbbbb
3. 新功能     ccccccccc
4. 新功能     ddddddddd

三、MarkDown部分语法

3.1.标题

　标题是每篇文章必备而且最常用的格式。在Markdown中，如果想将一段文字定义为标题，只需要在这段文字前面加上 #，再在 # 后加一个空格即可。还可增加二、三、四、五、六级标题，总共六级，只需要增加 # ，增加一个 # ，标题字号相应降低一级。如图：

3.2列表

　　列表格式也很常用，它可以让你的文稿变得井井有条。在 Markdown 中，你只需要在文字前面加上 - 就可以了；如果你希望是有序列表，在文字前面加上 1. 2. 3. 即可。

　　注：-、1.和文字之间要保留一个字符的空格。

3.3引用

　　如果你需要在文稿中引用一段别处的句子，那么就要用到「引用」格式。

　　在引用文字前加上 > 并与文字保留一个字符的空格，即可。

 

3.4粗体和斜体

　　Markdown 的粗体和斜体也非常简单：

　　用两个 * 包含一段文本就是粗体的语法；

　　用一个 * 包含一段文本就是斜体的语法。

3.5链接与图片

　　链接：在 Markdown 中，插入链接只需要使用 [显示文本](链接地址) 即可。

　　图片：在 Markdown 中，插入图片只需要使用 即可。

　　注：插入图片的语法和链接的语法很像，只是前面多了一个 ！

 

3.6分割线

　　分割线的语法只需要另起一行，连续输入三个星号 *** 即可分割两段文字内容。如图：

3.7表格

当你需要在Markdown文稿中键入表格，代码如下：

 

3.8代码高亮

3.9制作代办事项To-do List

 

3.10高效绘制流程图，序列图，甘特图，表格

3-1流程图

3-2 序列图

3-3 甘特图

3-4，表格

3.11书写数学公式