Directory Structure

This is a brief guide on the directory layout of taproot.

.gitlab

Contains the CI Docker image and build tools.

.vscode

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

build_tools

Contains tooling used to build generated code. Files in this directory may be generated and used in projects that utilize taproot.

docs

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

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.

src

Contains all header and source files that are a part of taproot.

test

Contains all tests for taproot that validate the correctness of the library code.

test-project

Contains a test project that taproot. It can be used for basic testing and as a generation/build smoke-test. However, changes made by ARUW members should typically be tested in the context of aruw-mcb before being merged here.