This is sample documentation auto-generated from the C++ Bootstrap Project. logo image

Documentation is for a hypothetical application called RedFlame. See the source code, documentation source, and build automation at the C++ Bootstrap Project on GitHub.

RedFlame Documentation

Documentation for RedFlame version 0.1.1.

Instructions

Create an introductory paragraph or more that describes your application at the highest level. Several docs include this intro; the Design doc, User Guide, Manpage and this Top level index page. Modify contents in docs/src/include/introduction.rst and then eliminate this admonition from there.

RedFlame is a high performance application that …

The following documents are available:

Manpage: The manual page for this application.
User Guide: Describes how to use this application.
External API: Documentation for the external REST API.
Internal API: Documentation for internal elements auto-generated from source code.
Code Coverage Results: Results from running code coverage analysis (lcov).
Static Analysis Results: Results from running cpp-check.
Design Document: Documentation of the design of the application.
Licenses: Announces open source licenses and usage rights applicable to the source code and repository.
Open Source Inventory: List of open source packages.