README.md编写

一、摘要

        项目一般会有个描述文件，对于项目的代码来讲，这个描述就是README.md文件，可以描述各模块功能、目录结构等。该文件可以方便让人快速了解项目的代码结构和功能。当然，若要深层次的了解项目，就得看项目总体的需求规格说明书、概要设计说明书、详细设计说明书了。

二、语法

        一个md文件如下，有标题，标题下可以有代码、说明、链接等。

2.1 标题语法

        标题用“#”来标识，几个#就代表几级标题，标题和#之间有个空格。比如：“# 一级标题”、“## 二级标题”、“### 三级标题”。其中一级标题最大。

2.2 列表语法

        原点符：一个“*”和一个空格会变成原点符，具体如下：

        若用tab键和*以及空格，则会显示不同的效果，具体如下：

         可以看到*+空格 后的内容会将换行符转化成空格，且每一级显示原点不一样。

2.3 文字样式

        斜体用“*”或“_”包围，粗体用“**”或“__”包围，粗斜体用“***”或“___”包围，删除线用“~~”包围。

2.4 引用

        在内容前面加“>”，引用可以嵌套，具体如下：

2.5 代码块

         对于单行代码用“`”包裹，多行代码则用“```”包裹。具体如下：

2.6 分割线

         三个以上的“*”或“_”或“-”就可以产生一条分割线。

2.7 链接

        链接的文字用[]包围，链接的地址用[]后的()包围，具体如下：

         点击链接后就会自动跳转括号内的地址，[]内的描述可以是中文也可以是英文。