PS: 因为我写的不好看、不规范，所以搜罗了一下相关资料，留着有空学学~~~

前言

既然今天冠冕堂皇的写了规划，那就了解下GitHub中markdown如何写的规范些吧，找了几个链接：
基本撰写和格式语法
 如何为开发项目编写规范的README文件（windows）
[译] 如何写出优雅且有意义的 README.md
知乎：如何写好Github中的readme？

可以速查的

介绍了常用的类型的md形式
 给出了常用的表情符号码

内容结构

[功能描述]：主要描述一下这个项目的主要功能列表。
[开发环境]：罗列使用本工程项目所需要安装的开发环境及配置，以及所需软件的版本说明和对应的下载链接。
[项目结构简介]：简单介绍项目模块结构目录树，对用户可以修改的文件做重点说明。
[测试DEMO]：此处可以简单介绍一下DEMO程序的思路，具体实现代码放在example文件夹中。
[作者列表]：对于多人合作的项目，可以在这里简单介绍并感谢所有参与开发的研发人员。
[更新链接]：提供后续更新的代码链接。
[历史版本]：对历史版本更改记录做个简单的罗列，让用户直观的了解到哪些版本解决了哪些问题。
[联系方式]：可以提供微信、邮箱等联系方式，其他人对这个工程不明白的地方可以通过该联系方式与你联系。
source url

进阶学习