README规范总结

最新推荐文章于 2024-07-27 11:04:32 发布

窦朋飞

最新推荐文章于 2024-07-27 11:04:32 发布

阅读量4.5k

点赞数 3

分类专栏：规范文章标签： intellij idea 编辑器

本文链接：https://blog.csdn.net/doupengzp/article/details/105089076

版权

规范专栏收录该内容

1 篇文章 0 订阅

订阅专栏

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