Skip to content

Documentation

There are two complementary documentation entry points:

  1. User guide (recommended for day-to-day usage)
  2. File: docs/User_Guide.md
  3. Covers installation, build, command-line options, configuration files, output layout, and troubleshooting.

  4. Doxygen API documentation (recommended for code internals)

  5. Install doxygen.
  6. From docs/, run: doxygen Doxyfile
  7. Open docs/html/index.html in your browser.

If you are new to the project, start with User_Guide.md and then use Doxygen when you need function-level details.