02readme.md书写规范
一、简单readme.md书写规范
# 项目介绍
# 环境依赖
# 目录结构描述
├── ReadMe.md // 帮助文档
│ ├── path // 子文件夹
│ ├──file // 文件
└── temp
# 功能介绍
# 使用说明
# 版本内容更新
二、项目完整readme.md书写规范
# 标题
项目描述
## 目录
- [背景](#背景)
- [安装](#安装)
- [环境依赖](#环境依赖)
- [安装步骤](#安装步骤)
- [使用说明](#使用说明)
- [相关项目(可选)](#相关项目)
- [主要项目负责人](#主要项目负责人)
- [参与贡献方式(可选)](#参与贡献方式)
- [贡献人员](#贡献人员)
- [开源协议(可选)](#开源协议)
## 背景
## 安装
### 环境依赖
### 安装步骤
## 使用说明
## 相关项目
## 主要项目负责人
## 参与贡献方式
非常欢迎你的加入 或者提交一个 Pull Request。
标准 Readme 遵循 [Contributor Covenant](http://contributor-covenant.org/version/1/3/0/) 行为规范。
### 贡献者
感谢以下参与项目的人:
<a href="graphs/contributors"><img src="https://www.baidu.com" /></a>
## 开源协议
[MIT](LICENSE) © xxxx