如何写好README.md文件

在github上阅读源码时，为更快速了解代码结构需先阅读README.md文件。md是一种博客编写语言（Markdown）,为快速熟悉该语言，现将书写规范总结如下：

1.标题书写格式

#号+空格 ,输入标题内容

# 一级标题
## 二级标题
### 三级标题
#### 四级标题

2.列表书写格式

（1）无序列表
* 列表
+ 列表
- 列表
（2） 有序列表
1. 列表1
2. 列表2
3. 列表3   

3.勾选框

- [x] 内容1
- [ ] 内容2

显示效果

• 内容1
• 内容2

4.强调

*斜体*
**粗体**
***粗斜体***
~~删除线~~

5.高亮区域设置

• 如果要高亮显示一行代码,使用键盘上Tab上方和！左方的按钮“ ` ” （注意要在英文模式下!!!），

`hello world`

显示效果如下:
hello world

• 如果要高亮显示多行区域，将Tab上方按钮连续成对按三次,

```python
多行代码```

6.插入图片

![img](图片地址)

7.超链接

[文本](超链接)

8.插入表格

标题  |   标题  |   标题     
----  |   ----  |   ----   
内容  |   内容  |   内容  

9.分割线

***
---

10.多级树结构

> 一级菜单       
>> 二级菜单       
>>> 三级菜单    

11.如何使用生成的目录

在cmd命令窗口，寻找到要生成目录的文件夹，使用tree命令既可生成目录，若需将目录生成到指定文件，采用下方命令：tree/f>list.txt，在当前目录下生成一个list.txt文件，打开文件将需要的目录复制后粘贴到README.md文件中。