README文档

折腾嵌入式开发时遇到很多项目源码根目录中都有README

折腾web领域很多库的源码根目录中也有一个：README或README.md

README的作用

• README=read me=读我=（项目作者希望你在使用其项目之前）读我（这个说明文件）=（项目/代码的基本的）使用说明（+版权声明等等）

换句话说：你使用该项目/库/代码 之前，最好要好好读一读。

-》可以了解到项目的背景，来源，版权声明，等等信息。

而README的格式，一般就是普通的文本文件。

如果是README.md，则是Markdown的格式，更加易写易读。

README的支持

对于md格式的README.md，很多代码托管平台，比如：

• github.com
• gitee.com

都默认自带支持，在web端打开项目首页时，自动加载README.md，显示出友好的格式化后的内容：

• gitee.com 显示README.md的效果
  • 
• github.com 显示README.md的效果
  • https://github.com/crifan/crifan_ebook_readme
    • 

换句话说：

如果你想要给项目写基本的说明和注意事项等内容，则可以在项目根目录中，填写README.md文件，然后用markdown格式去写内容，上传到gitee.com或github.com后，页面上自动帮你生成项目说明文档了。很是方便。