ASAP documentation!

Last Updated on 2024-01-29

Welcome! This is the documentation for the asap project. This is the top level container project for the asap modules. It provides the integrated build system and the overall structure for projects following the asap development workflow.

The main goal from this family of modules and projects is to significantly cut the bootstrap time of starting a new c++ application, using CMake as the build system.

Parts of the documentation

Getting Started!

start here to understand how to use this project as a starter for your own project

Project Development

refer to this part of the documentation to understand the build system specifics for this project, the development workflow, coding and unit testing guidelines

Documentation

refer to this part of the documentation to understand how project documentation is structured and built from source using `doxygen` and `sphinx`.

Project Tools

get an introduction to the programs and scripts under the `tools` folder, specifically made for the `asap` project. These can simplify recurring tasks and provide additional insights into the project, and sometimes examples of how to use the project artifacts.

Acknowledgements

This documentation uses the theme provided by the Executable Books Project Project.