oracle md060 模板,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.jsforever 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

混淆

一般来说，开源库都会设置一些混淆规则的，部分项目由于项目类型特殊之处，所以就没有混淆这一项，具体的看开源项目来定。

关于作者

作者姓名 roc

联系方式：admin@qzroc.com

贡献者/贡献组织

请阅读 CONTRIBUTING.md 查阅为该项目做出贡献的开发者。

鸣谢

该项目参考了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