如何在开发项目的时候写出标准的README文件？
为什么要写这篇博客？
关于README的编写，这个也十分的重要，如果你觉得只是随便写写，那么你就错了；编写这部分也是相当的重要的。工欲善其事，必先利其器。故而我们在这里介绍一款编译器MarkDown编译器。
对于大神来说，可能这不算什么，但对于小白的我们这个还是十分的有用的；其语法比较简单，在几分钟之内就能够很轻松的学会这个软件。
在这个部分我大致分为两个部分向大家进行介绍：
关于完整的README的内容
关于README的内容，我觉得每个项目里面都应该有这么一个文件，目的是为了能简要描述该项目的信息，让读者快速了解这个项目。
一、它需要说一下几个事项
- 软件定位，软件的基本功能
- 运行代码的方法：安装环境，启动命令
- 简要的使用说明
- 代码目录结构说明，更详细点可以说明软件的基本原理
- 常见问题说明
二、它包括一下几个内容
- 项目和所有子模块和库的名称（对于新用户，有时不同命名会导致混乱）。
- 对所有项目，和所有子模块和库的描述
- 如何使用 5-line code（如果是一个库）
- 版权和许可信息（或阅读许可证）
- 抓取文档指令
- 安装、配置和运行程序的指导
- 抓取最新代码和构建它们的说明（或快速概述和「阅读 Install」）
- 作者列表或「Read AUTHORS」
- 提交bug，功能要求，提交补丁，加入邮件列表，得到通知，或加入用户或开发开发区群的介绍
- 其他联系信息（电子邮件地址，网站，公司名称，地址等
- 一个简短的历史记录（更改，替换或者其他
- 法律声明
三、一个简单的范本（当然，我们前期写的话，不必要那么麻烦，就写几个简单的必要的东西，比如法律声明啊，联系记录啊等等，就不必要写）
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
具体语法参照这篇简书的文章MarkDown使用指南
关于windows程序如何生成结构目录树
windows程序如何生成目录结构树？ 电脑中打开cmd 在cmd中进入要生成目录结构的目录 输入：tree /f > list.txt（目录结构输入成功，并保存为一个list.txt文件） 打开此文件，即可看到生成的目录结构树