🤖 $YOUR_PROJECT

A TODO: brief description of your project here in ROS 2.

Important

If you've used this project template, the following steps may be helpful for your repository's configuration!

1. Find all TODO statements and note (and ideally complete) each referenced task. Take special note of the

   grep TODO

2. Read all README.md files and adjust wording to fit your unique project.

   find -type f -name README.md 

3. Delete this block from your project's README.md!

Usage

How can I install and use this project?

Documentation

Tip

If you haven't yet installed this project, continue on to the installation instructions.

Documentation is en route, but for now: the following example shows a representative subset of the project's functionality.

Installation

All $YOUR_PROJECT packages are simplest to install using their Debian binaries, and the binaries are simplest to install using the GitHub CLI.

gh release download --repo bdaiinstitute/$YOUR_PROJECT --pattern '*.deb'

sudo dpkg -i *.deb

Alternatively, you can build from source after adding this project to your ROS 2 workspace using vcs, git submodule, or gitman.

Contributing

How can I help develop this project?

Thanks for your interest! Instructions for contributing to this project are available in CONTRIBUTING.md.