wiki/org/Git 协作规范/关于（Readme）.md

---
id: 关于（Readme）
title: 关于（Readme）
data: 2022年6月15日
sidebar_position: 4
---

## 规范

- 文件命名：README.md、README_EN.md，根据项目受众群体标定关于文档的默认语言。
- 徽章：[https://shields.io/](https://shields.io/)

### 中文模板

```markdown
## 项目

 ### 徽章
 ### 简介
 ### 演示
 ### 原理图 / 流程图
 
## 用法

 ### 安装
 ### 文档
 ### F&Q

## 路线

 ### 开发路线
 ### 更新历史（可单独文件）

## 贡献
 
## 致谢

## 协议

```

### 英文模板

```markdown
## Project

 ### Badges
 ### Introduction
 ### Demo
 ### Schematic / Flowchart
 
## Usage

 ### Install
 ### Documentation
 ### F&Q

## Map

 ### Development map
 ### Update history (can be a separate file)

## Contribute
 
## Thanks

## License
```