Documentation
There are two complementary documentation entry points:
- User guide (recommended for day-to-day usage)
- File:
docs/User_Guide.md -
Covers installation, build, command-line options, configuration files, output layout, and troubleshooting.
-
Doxygen API documentation (recommended for code internals)
- Install doxygen.
- From
docs/, run:doxygen Doxyfile - Open
docs/html/index.htmlin your browser.
If you are new to the project, start with User_Guide.md and then use Doxygen when you need function-level details.