重要的README.MD

项目说明文件

一般来说，我们都会在项目根目录下建立一个README.md文件，它是Markdown语法格式编写的文本文件，一般用于对整个项目进行说明描述

README 文件示例

一般来说，我们会在README中写入以下描述：

1. 项目名称(标题)以及详细的介绍
2. 项目的功能特性(Features)——告诉他人我们的项目能干什么
3. 安装步骤(环境搭建)——告诉他人我们的项目要怎么样安装和运行
4. 问题描述/BUG追踪
5. 协议(License)
6. 即将加入的特性(Todo)—-告诉他人我们的项目未来会加入那些特性
7. 更新日志(Changelog)——告诉他人我们的项目更新了那些东西
8. 贡献者(项目成员)
9. 鸣谢

虽然说README文件不是必须的，但是它可以帮助我们更好地规划和管理项目信息，因此建议养成编写README文件的习惯，尤其是你在开发一个开源项目的时候

Markdown 语法简述

Markdown是一种可以使用普通文本编辑器编写的标记语言，通过简单的标记语法，它可以使普通文本内容具有一定的格式。

标题

• H1 : # 标题文字
• H2 : ## 标题文字
• H3 : ### 标题文字
• H4 : #### 标题文字
• H5 : ##### 标题文字
• H6 : ###### 标题文字

文本样式

• 链接 : [链接文本](URL)
• 粗体 : ** 粗体文本 **
• 斜体 : _斜体文本_或 *斜体文本*
• 删除线 : ~~删除文本~~
• 引用 : > 引用内容
• 代码 : `代码`
• 代码块 : ```代码块```
• 水平线 : ---或***
• 图片 : ![](图片URL)
• 数学表达 : $$ 数学表达式 $$
• 无序列表 : * 列表项 注意中间的空格
• 有序列表 : 1. 列表项 注意中间的空格(每项前都是该项的数字)

更多Markdown语法请参考 http://www.appinn.com/markdown/

使用HTML标签

有时候你也可以使用HTML标签来书写

比如<strong>强调文本</strong>将会输出 强调文本

Markdown 编辑器

如果你已经在使用像Sublime Text、VSCode、Atom这样的文本编辑器，那么恭喜你，你可以直接使用它们创建.md文件并编辑

你也可以使用一些专门的Markdown编辑器来创作，有免费的也有收费的，完全取决于你

Markdown 编辑器推荐 https://sspai.com/post/27792