README

Documentation

This directory contains higher level documentation related to the codebase. Lower level code documentation (such as documenting the parameters of a function) should go directly in the code as docstrings, doxygen comments, etc.

Directory Structure

• code-overview: High-level documentation of the code.

• development: Tips and guidelines for developing this codebase. E.g. linting, how to add dependencies.

• install: Additional documentation for installing the necessary tools to develop ROS code. Note: most of the documentation for this is in the README at the top level of this repo.

• onboarding: Resources for new members. Includes the new member activity.

• rover: Instructions for how to set things up on the rover. E.g. how to connect to the rover wirelessly, how to set up canbus, etc.