什么是Readme？

README（顾名思义：“read me“）是启动新项目时应该阅读的第一个文件。它既包含了一系列关于项目的有用信息又是一个项目的手册。它是别人在 Github 或任何 Git 托管网站点，打开你仓库时看到的第一个文件。

Readme.md 文件位于仓库的根目录中，在 Github 上的项目目录下它会自动显示。

.md 这个文件后缀名来自于单词：markdown。它是一种用于文本格式化的标记语言。就像 HTML 一样，可以结构化地展示我们的文档。

为什么要写Readme？

README文件的意义在于说明你的项目做了什么? 运行在什么样环境下? 如何查看/编辑代码? 其目的在于向使用者描述该项目的信息，让读者快速了解这个项目。

就像找工作要写个人简历一样，为自己的开源项目写一个优秀的 README 文档同样重要。好的 README 文档可以帮助你在众多将项目寄托到github上的开发人员中脱颖而出。

在Readme里写些什么？

项目标题

这是整个项目的名称，标题应具有自我解释性，尽量不要太拗口。

项目简述

添加一些简短的陈述，描述整个项目出现原因和作用。包括但不限于

• 你的项目的作用

• 你使用某种技术的原因

• 你面临的一些挑战和还未实现的功能

添加新功能或修复错误

这是为了让别人了解如何在你的项目中提出问题或提出功能要求。

目录（可选）

如果你的readme文件很长，可能需要添加一个目录，以方便用户查找所需内容，帮助他们快速导向文件的不同部分。

安装

如果你的项目是需要安装的软件或应用程序，则应包括安装项目所需的步骤。提供如何运行开发环境的手把手教学说明。

使用

提供说明和示例，以便用户/贡献者可以使用该项目。这将使他们在遇到问题时更容易解决，你还可以引用屏幕截图来显示正在运行的项目示例。

最好对项目进行演示或预览（视频 / gif / 屏幕截图都是不错的选择），以便人们知道你的项目中会有什么。（图片、视频链接、在线演示 Demo 链接)

友情链接

如果你作为团队或组织参与项目，请列出你的合作者/团队成员。你还应该引用指向他们的GitHub简介的链接。

此外，如果你引用了其他的辅助项目来构建特定的项目，也请在这里引用指向该项目的链接。

列出许可

这是大多数readme文件的最后一部分。它让其他开发人员知道他们可以或者不能对你的项目做什么操作。如果你需要选择许可，使用<u>https://choosealicense.com/</u> 。