README-TEMPLATE

[icon]

# Name

# Badge-徽章

------ 备注：某些 READMEs 上，可能会看到小图像，例如项目是否通过了所有测试。可以使用护盾在阅读器中添加说明。许多服务中也有添加徽章的说明。

## Introduction-项目介绍

------ 备注：让人们知道项目具体可以做什么。对阅读者任何可能不熟悉的地方，提供参考及访问链接；此处还可添加功能列表或背景的子菜单。如果有同类项目，应该在介绍中说明差异化、优势分析。

### Summary-概要

### Features-特性

## Requirements-环境依赖

------ 备注：环境，对所有项目，和所有子模块和库的描述。

## Configuration-配置

------ 备注：项目所需要的配置信息 。

## Installation-安装

------ 备注：如何安装，部署 ，最好包括界面操作截图及视频。

## Usage-用法

------ 备注：项目的入门使用方法 ，最好包括界面操作截图及视频

## Development-开发

------ 备注：关于怎样开发的文档信息，如 API 、兼容性等。

## Changelog-更新日志

------备注： 一个简短的历史记录，更改，替换或者其他。

## FAQ-常见问题

------备注： 常见的问题汇总，便于解决后续的新手答疑。

## Support-支持

------ 备注：告诉用户可以去哪里寻求帮助。如问题跟踪器、聊天室、电子邮件地址等。

### Doc-文档

------ 备注：更多的文档说明 。

### Release planning-版本规划

------ 备注：对项目未来方向的规划。

### Contact and Join-联系和加入社区

------ 备注：可以包括但不限于如下条目

• 用户社区的加入路径（微信/QQ/其它群二维码、项目助手的 ID等）
• 项目的邮件订阅
• 公司名称、网站、地址
• 通过提交issue 联络解决遇到的问题

## Contributing-贡献

------ 备注：贡献指引。

### Contributors 贡献者

----- 备注：作者列表和鸣谢。

## License-版权信息

------ 备注：版权、许可信息、法律声明。

## Status 项目状态

------ 备注：如果项目暂缓或停止更新，请进行状态标注。开发者可能会选择 fork 项目或自愿加入维护者或成为所有者，让其继续下去。同时，可在此处对维护者提出明确请求。