跟着自己的脚步去进步，踏好每一步，虽然不一定成功，但无悔

一、readme用什么工具去写？？

1.1 为什么要使用MarkDown编辑器来书写Readme

github等代码托管平台上的项目的Readme.MD文件都有其特定的语法，称之为Markdown语法。

1.2 什么是MarkDown语言

markDown是一种轻量级的标记语言，它允许使用易读易写的纯文本格式编写文档。

1.3 MarkDown标记

1.3.1 标题

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

1.3.2 段落

段落的换行是使用两个以上的空格加回车
段落换行

1.3.3 字体

符号与文字之间不需要空格

*斜体文字* 斜体文字
**粗体文字** 粗体文字
***粗斜体文字*** 粗斜体文字
~~删除线~~~~删除线~~
<u>下划线</u> 下划线

1.3.4 列表

1.3.4.1 无序列表

* 第一项
* 第二项
* 第三项

第一项
第二项
第三项

1.3.4.2 有序列表

1. 第一项
2. 第二项
3. 第三项

第一项
第二项
第三项

1.3.4.3 列表嵌套

1. 第一项
   - 第一项子项
   - 第一项子项

第一项
- 第一项子项
- 第一项子项

1.3.5 表格

| 表头 | 表头 |
| --- | --- |
| 单元格 | 单元格 |
| 单元格 | 单元格 |

表头	表头
单元格	单元格
单元格	单元格

1.3.6 引用

> www.baidu.com

www.baidu.com

1.3.7 链接与图片

1.3.7.1

这是[百度地址](https://www.baidu.com)

这是百度地址

这是<https://www.baidu.com>

这是www.baidu.com

1.3.7.2

! [RUNOOB 图标](https://p3-jue如何jin.byteimg.com/tos-cn-i-k3u1fbpfcp/a1acbcb94d7846e38f34a72a71bf3e33~tplv-k3u1fbpfcp-zoom-1.image "RUNOOB")

! RUNOOB 图标

readme要写什么？？

项目背景
安装与使用
Badge
相关项目(可选)
主要项目负责人
参与贡献方式
开源协议(License)

项目背景

需要说明项目名称，项目功能描述，仓库目的

安装与使用

开发环境配置 项目运行需要什么环境 开发&发布命令 我们怎样通过命令开启本地开发，以及构建发布

重新开始--如何写readme