开发者社区> 刘新伟> 正文
阿里云
为了无法计算的价值
打开APP
阿里云APP内打开

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

简介: 翻译自@PurpleBooth 的 README 模板 项目标题 使用一段话简要描述项目内容。 获得开始 这些说明将为您提供一个在你的个人本地计算机上启动和运行的项目副本,以便进行开发和测试。有关如何在实时系统上部署项目的细节,请参阅部署。
+关注继续查看

翻译自@PurpleBoothREADME 模板

项目标题

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

获得开始

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

先决条件

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

给一些例子

安装使用

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

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

给出示例

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

运行测试程序

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

分解为端到端测试

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

给出示例

编码样式测试

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

给出示例

部署

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

内置

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

投稿

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

版本

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

作者

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

许可证

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

致谢

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

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
springMvc40-restful的crud的项目原型介绍
springMvc40-restful的crud的项目原型介绍
3 0
工程化的项目中使用什么作为唯一ID(附代码) | 架构篇
工程化的项目中使用什么作为唯一ID(附代码) | 架构篇工程化的项目中使用什么作为唯一ID(附代码) | 架构篇
49 0
照着官方文档学习react
不晓得啥情况,markdown在csdn识别错误?排版后面的代码被破坏了,正确的排版:https://ryan-miao.github.io/2017/08/03/react-tutorial-1/ 笨人学习法 10000个小时策略来学习,因为笨。
892 0
【《Objective-C基础教程 》笔记ch02】(一)Hello Object-C 项目
一、项目实现步骤。 1、若xcode尚未运行,先启动它。 2、选择Select File --> New --> New Project菜单选项。 3、选择左边OS X下得application,再选中右边的command line tool,点击next。
889 0
+关注
刘新伟
自学 python,MXNet,Keras,Tensorflow 博客园:http://www.cnblogs.com/q735613050/ 慕课网:https://www.imooc.com/u/546
文章
问答
文章排行榜
最热
最新
相关电子书
更多
前端自动化测试
立即下载
低代码开发师(初级)实战教程
立即下载
阿里巴巴DevOps 最佳实践手册
立即下载