README 模板

1,044 阅读1分钟

README 模板

[icon]
# Name
[Badges]
## Introduction - 介绍
### Summary - 概要
### Features - 特性
## Requirements - 必要条件(环境,对所有项目,和所有子模块和库的描述。)
## Configuration - 配置(配置信息。)
## Installation - 安装(如何安装。)
## Usage - 用法(用法。)
## Development - 开发(关于怎样开发的文档信息。(API 等。))
## Changelog - 更新日志(一个简短的历史记录(更改,替换或者其他)。)
## FAQ - 常见问题(常见问题。)
## Support - 支持
### Dos - 文档(更多文档。)
### Contact - 联系
(其他联系信息(电子邮件地址,网站,公司名称,地址等)。
提交bug,功能要求,提交补丁,加入邮件列表,得到通知,或加入用户或开发开发区群的介绍。)
## Authors and acknowledgment - 贡献者和感谢(作者列表和鸣谢。)
## License - 版权信息(版权和许可信息(或阅读许可证)、法律声明。)