https://blog.csdn.net/bcfdsagbfcisbg/article/details/78285804

一、readme文件包含內(nèi)容
我們在項(xiàng)目中常常看到README.md 當(dāng)然擴(kuò)展名可能是txt ,rb,md ,甚至 me都有可能。README 應(yīng)該是介紹code source 的一個(gè)概覽，基本可以涵蓋以下幾部分內(nèi)容：

引用塊內(nèi)容
你的項(xiàng)目介紹
你的代碼實(shí)現(xiàn)了什么功能?
該如何使用? (系統(tǒng)環(huán)境參數(shù),部署要素)
代碼組織架構(gòu)是什么樣的?
版本更新重要摘要

二、demo

DEMO
===========================###########環(huán)境依賴
node v0.10.28+
reids ~###########部署步驟
1. 添加系統(tǒng)環(huán)境變量export $PORTAL_VERSION="production" // production, test, dev2. npm install  //安裝node運(yùn)行環(huán)境3. gulp build   //前端編譯4. 啟動(dòng)兩個(gè)配置(已forever為例)eg: forever start app-service.jsforever start logger-service.js###########目錄結(jié)構(gòu)描述
├── Readme.md                   // help
├── app                         // 應(yīng)用
├── config                      // 配置
│   ├── default.json
│   ├── dev.json                // 開發(fā)環(huán)境
│   ├── experiment.json         // 實(shí)驗(yàn)
│   ├── index.js                // 配置控制
│   ├── local.json              // 本地
│   ├── production.json         // 生產(chǎn)環(huán)境
│   └── test.json               // 測試環(huán)境
├── data
├── doc                         // 文檔
├── environment
├── gulpfile.js
├── locales
├── logger-service.js           // 啟動(dòng)日志配置
├── node_modules
├── package.json
├── app-service.js              // 啟動(dòng)應(yīng)用配置
├── static                      // web靜態(tài)資源加載
│   └── initjson
│       └── config.js       // 提供給前端的配置
├── test
├── test-service.js
└── tools###########V1.0.0 版本內(nèi)容更新
1. 新功能   aaaaaaaaa
2. 新功能   bbbbbbbbb
3. 新功能   ccccccccc
4. 新功能   ddddddddd

總結(jié)

以上是生活随笔為你收集整理的readme示例的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。