Reference¶
Facts to look up. The pages marked generated are made from the code or the records by a script, and CI fails when they no longer match, so they cannot drift.
- Command line (generated from
--help): every option oftracemaker, its subcommands,tracemaker-placeandtracemaker-view. - Viewer protocol: the JSON messages between the engine and the live viewer.
- Benchmark results (generated from
bench/records/): every recorded run. - C++ API (generated by Doxygen from the headers): classes and functions of the engine.
- Component rules catalogue: the detected part categories and their rules
(
component_rules.yaml). kicad_plugin/README.md: the plugin's environment variables and Python module.