我们在项目中常常看到README.md 当然扩展名可能是txt ,rb,md ,甚至 me 都有可能.
这就是你在github上创建一个项目的是,总会提示你要不要生成一个README.md 文件.
README 应该是介绍code source 的一个概览.其实这个静态文件是有约定成俗的规范.
你的项目介绍 你的代码实现了什么功能? 该如何使用? (系统环境参数,部署要素) 代码组织架构是什么样的? 版本更新重要摘要
如果你的README包括上面的内容,那么当使用者拿到代码,打开README后,基本就知道该如何下手了.如下 README.md :
DEMO =========================== ###########环境依赖 node v0.10.28+ reids ~ ###########部署步骤 1.
当然这不是一个固定的范本,有的人甚至把开原协议也写进来.有的人喜欢把changeLog 独立拿出来再创建一个CHANGELOG.md 的文档.