【C++后端学习】02、readme.md书写规范

02readme.md书写规范

一、简单readme.md书写规范

# 项目介绍

# 环境依赖

# 目录结构描述
	├── ReadMe.md     // 帮助文档
	│   ├── path     // 子文件夹
	│   	├──file     // 文件
	└── temp 

# 功能介绍

# 使用说明

# 版本内容更新

二、项目完整readme.md书写规范

# 标题
 项目描述

## 目录
- [背景](#背景)
- [安装](#安装)
    - [环境依赖](#环境依赖)
    - [安装步骤](#安装步骤)
- [使用说明](#使用说明)
- [相关项目(可选)](#相关项目)
- [主要项目负责人](#主要项目负责人)
- [参与贡献方式(可选)](#参与贡献方式)
    - [贡献人员](#贡献人员)
- [开源协议(可选)](#开源协议)

## 背景

## 安装
### 环境依赖
### 安装步骤

## 使用说明

## 相关项目

## 主要项目负责人

## 参与贡献方式

非常欢迎你的加入![提一个 Issue](https://github.com/xxx) 或者提交一个 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

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值