项目的自述文档(README)模板

0.514字数 452阅读 20

翻译自@PurpleBoothREADME 模板

项目标题

使用一段话简要描述项目内容。

获得开始

这些说明将为您提供一个在你的个人本地计算机上启动和运行的项目副本,以便进行开发和测试。有关如何在实时系统上部署项目的细节,请参阅部署。

先决条件

需要安装什么软件以及如何安装它们。

给一些例子

安装使用

提供一些例子说明你是如何部署运行的环境的。

表述部署的步骤是什么,并给出示例:

给出示例

最后,以一个小 demo 结束:从外部获取数据,并使用部署好的环境展示项目。

运行测试程序

解释如何提供这个系统的自动化测试。

分解为端到端测试

解释测试的内容以及原因。

给出示例

编码样式测试

解释测试的内容以及原因。

给出示例

部署

添加有关如何在实时系统部署此项的其他说明。

内置

  • 使用的框架,如 Dropwizard
  • 依赖项管理,如 Maven
  • 用于生成 RSS 源,如 ROME

投稿

请阅读 CONTRIBUTING.md,了解我们的行为准则以及如何向我们提交拉取请求的过程。

版本

我们使用 https://semver.org/lang/zh-CN/ 进行版本控制。有关可用的版本,请:book:此存储库中的标记

作者

另请参阅参与此项目的贡献者列表。

许可证

此项目根据 MIT 许可证获得许可 - 有关详细信息,请参阅 LICENSE.md 文件。

致谢

  • 感谢所有使用本项目的人
  • 激励
  • etc