The source code for the Sim Racing Library is fully documented with comments formatted for the Doxygen documentation generator. This folder contains the files needed to generate the Doxygen documentation.

The generated documentation is hosted online on GitHub Pages. The documentation generation has been automated using GitHub Actions and should be up to date with the latest release.

You can generate this documentation locally by installing Doxygen and running the program with the included Doxyfile:

doxygen Doxyfile

The project is configured to use the Doxygen Awesome theme for a more modern look. This is optional - the documentation will build successfully without these extra CSS files. To add them, clone the repository and place it into the 'docs' folder alongside the Doxyfile.

Unless otherwise stated, documentation and images are licensed under the terms of the Creative Commons Attribution-ShareAlike 4.0 license (CC BY-SA 4.0). See the LICENSE file for more information.