Skip to content

README template

Michael Hoyer edited this page Feb 4, 2021 · 5 revisions

Every package should contain a readme. The content of the readme should follow, but is not limited to, the following template:

# <name of package>

Description of what this package is, what it does, and why it is needed. 

## Inputs and outputs

List of topics/actions/services this package provides or uses. 
This list should also include the respective message types.

## Setup instructions

Some good instructions on what parameters need to be set and why

Example: