Welcome to the Drone Software repository of the Mars Rover Design Team (MRDT) at Missouri University of Science and Technology (Missouri S&T)! This repository contains the source code, documentation, and other resources for the development of the Drone Software for our Drone. The Drone Software project aims to compete in the University Rover Challenge (URC) by assisting our rover in the delivery mission.
Everytime a commit is made to the development branch, a GitHub Action is ran that autonomatically generates documentation for files, classes, methods, functions, namespaces, etc. using Doxygen. To ensure that Doxygen can properly document and use your comments, make sure to use the documentation templates HERE. If you're running the development container in VSCode the templates can be automatically generated by typing /**<enter>. Regardless, all file, method, and function documentation must be use the template's style across the whole project.
Click here for full Drone Software API Documentation.
The Drone Software project is organized into different directories, each serving a specific purpose. Here's a brief overview of the directories:
- The src directory serves as the main source code directory and contains the algorithms, interfaces, states, util, and vision directories mentioned above.