README.md文件的必要性

README.md文件的必要性

因为README的编写，过了很长时间后，你仍然知道代码里，当初你写了什么；因为README的编写，其他人看你的代码不需要那么费劲；因为README的编写，你代码的质量就大大的提高；因为README的编写，你的语言水平就大大的提高了。

完整的README包括哪些内容

README文件通常采用Markdown语言（一种标记语言，据说只有十个不到的标记符号，却能让人优雅地沉浸式记录，专注内容而不是纠结排版，达到「心中无尘，码字入神」的境界。）

1. 软件定位，软件的基本功能；
2. 运行代码的方法：安装环境，启动命令；
3. 简要的使用说明；
4. 代码目录结构说明，更详细点可以说明软件的基本原理；
5. 常见问题说明。

其他关键信息：

1. 项目和所有子模块和库的名称；
2. 对所有子模块和库的描述；
3. 如何使用某库；
4. 版权信息和许可信息；
5. 抓取文档指令；
6. 安装、配置和运行程序的指导；
7. 抓取最新代码和构建他们的说明（或快速概述和阅读Install）
8. 作者列表；
9. 提交bug；
10. 其他联系信息；（电子邮箱，网站，公司名称，地址）
11. 一个简短的历史纪录；
12. 法律声明。

MarkDown语言可以做什么?

1. 代码高亮
   

2. 制作代办事项TO-do-List
   

3. 绘制流程图，序列图，甘特图，表格
   
   
   
   

4. 书写数学公式
   

Markdown的语法

1. 标题（# ）
   
2. 列表（- ）(1. )
   
3. 引用
   
4. 粗体和斜体
   
5. 链接与图片
   

链接：在 Markdown 中，插入链接只需要使用 显示文本 即可。
图片：在 Markdown 中，插入图片只需要使用 [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-V3IGIOq2-1594199473635)(图片链接地址)]即可。

6. 分割线
   分割线的语法只需要另起一行，然后连续输入三个星号***即可分段两段文字的内容。
7. 表格
   
   
   其中：
   :-----表示左对齐
   ------:右对齐
   :------:中间对齐
8. 关于生成目录树
   使用cmd，或者windows powershell,cd到目录位置：输入命令tree /filename >filetree.txt
   查看目录树重定向到文件filetree.txt

参考文献

如果你想加载一篇你写过的.md文件，在上方工具栏可以选择导入功能进行对应扩展名的文件导入，
继续你的创作。

1. 有道云笔记MarkDown指南：
   http://note.youdao.com/iyoudao/?p=2411&vendor=unsilent14
2. 进阶版Markdown指南：http://note.youdao.com/iyoudao/?p=2445&vendor=unsilent14
3. 如何为开发项目编写规范的README文件（windows），此文详解。https://www.cnblogs.com/wj-1314/p/8547763.html