经验分享：给项目创建和编写README.md文件的步骤

在项目开发过程中，不仅要注意代码的编写质量，也要为合作开发打好基础，尤其是合作开发的时候，同事直接的代码需要熟悉，这就需要在开发的时候进行注释操作，方便别人维护和熟悉代码。除了上述两个重要的点之外，还需要在项目工程里面单独做项目大概情况介绍以及注意事项的操作，这就涉及到README.md文件的使用。

拿到一个新的项目，想要了解这个项目，恐怕首先想到的就是通过项目里的Readme文件了解信息。若觉得Readme文件里面的内容都是随便写写的话，那就大错特错了，git 、github、oschina、gitcafe的代码托管平台项目的Readme.MD文件都是有具体的特有的语法规则，称之为Markdown语法。具体的语法这里不再详细讲解，本篇博文想要讲解的是给项目创建README.md文件说明，以及编写说明的注意事项。

关于README的内容，个人觉得是开发过程中每个项目都应该有的文件，创建README文件的目的就是要简要的描述项目信息，方便别人快速了解项目大概情况。

README需要有的几个功能模块：

1、软件项目的定位，基本功能描述；

2、运行项目代码的方法，安装环境，启动方式命令等；

3、简明扼要的使用说明；

4、项目代码结构说明，更详细说明软件的原理；

5、常见问题说明，以及注意事项。

README还要包含的一些内容：

1、项目和所有子类模块和所有库的名字；

2、如何使用；

3、版权和许可信息；

4、针对所有项目和其子类模块、库的描述信息；

5、安装、配置和运行程序的指引向导；

6、拉取最新代码和构建时候的说明；

7、提交的bug、功能需求、补丁等介绍；

8、历史记录；

9、免责，法律声明等。

以上是对README文件的功能和使用的简单介绍，本博文是以git代码托管平台来创建项目的README文件的步骤来讲，其他代码托管平台创建README文件的步骤这里不再一一介绍，请自行查询了解。具体的操作步骤如下所示：

1、打开Git代码托管平台，然后进入想要创建README文件的项目，然后找到新建添加README文件的地方，点击新建README文件；

2、点击创建README文件之后，就会直接进入到README文件，然后根据README文件的编写规则，在README文件里面编写相关说明内容；

3、填写各个模块之后，然后点击保存即可。

以上就是本章全部内容，欢迎关注三掌柜的微信公众号“iOS开发by三掌柜”，三掌柜的新浪微博“三掌柜666”，欢迎关注！

三掌柜的微信公众号：

三掌柜的新浪微博：