Directory Structure

This is a brief guide on the directory layout of aruw-mcb.

.gitlab

Contains the CI Docker image and build tools.

.vscode

Contains VSCode project settings and tasks for building code through the VSCode interface.

aruw-mcb-project

The project folder contains all C++ source code, as well as some periphery build files and HAL generation tools.

• aruw-mcb-project/modm: Contains generated modm build tools and HALs that are used when building code to be deployed to the MCB.
• aruw-mcb-project/robot-type: Auto-generated file specifying the current robot we are targeting.
• aruw-mcb-project/sim-modm: Contains generated modm build tools and HALs that are used when building code to be ran on the hosted target.
• aruw-mcb-project/src: Contains all source code (not including any hosted unit tests).
  • aruw-mcb-project/src/taproot: See the definition here
  • aruw-mcb-project/src/aruwsrc: Contains robot specific code that may change from year to year.
• aruw-mcb-project/test: Contains all hosted unit tests. The structure of this directory should mirror src, with the exception of additional mock and fake code that may be needed for unit tests.

docs

Contains all the relevant information necessary for building the generated documentation using Exhale.

isolated-deploy

Contains information on how to standalone deploy to the MCB via Openocd. This is useful for when someone does not have a build environment on their machine.

modm

A submodule (embedded git repository) of modm, used during code generation.

scripts

Contains python and shell scripts that are either useful for developers or are used during CI builds.