Skip to content

Latest commit

 

History

History
40 lines (19 loc) · 1.51 KB

how-to-write-a-README-for-project.md

File metadata and controls

40 lines (19 loc) · 1.51 KB

约定

由于当前公司实习生众多,并且大部分实习生的实习期并不太长,甚至无法满足公司招收实习生的基本要求(不小于3个月,每周至少工作4天),因此很容易出现在上一位实习生实习结束后接手其工作的实习生难以进一步开展工作;除此之外,公司还有很大一部分实习生属于远程办公,导致在沟通上可能存在比较大的难度。

为了使公司的软件产出形成一定规范,并且具有非常大的可继承性,无论是对于实习生还是公司员工,在软件的README.MD编写要求上做以下规范,以资遵循。

内容要求

每个上传的项目必须要有README.MD文件。

README文件模板参照xbot_talker包说明

文件必须包含以下内容。

  • 简介

用于介绍当前程序包的功能是什么?输入输出是什么?与什么软件搭配使用?

  • 安装依赖

如果要运行该程序,对系统和其他软件或工具有何依赖?如何安装?安装教程给出。

  • 使用方法

如何使用?launch文件或者生成的其他可执行文件或.py文件运行时分别启动了什么?有何功能?

  • ROS API

包含对node,service,publisher,subscriber,msg,srv等的详细介绍。

  • 参考链接

有哪些可以参考的资料,如果上传了roswiki,请给出wiki页面的链接。

  • 联系我们

留下公司信息和维护者联系方式,以便沟通。