- Zig: 0.14
- Just (optional): To easily run the build, formatter or tests
This library is intended to be used as a C library. The main source file is in dist/core.c and the headers are in includes/. See examples/main.c for an example on how to use it.
To test if it worked, call is_instrumented which should return false when running without Codspeed. To run with Codspeed, execute the following:
codspeed run -- <your_cmd>
To make sure your integration is fully working, you have to implement all these hooks:
- start_benchmark: Call this when the benchmark starts, to start measuring the performance.
- stop_benchmark: Stop measuring the performance after the benchmark stopped.
- set_executed_benchmark: Provide metadata about which benchmark was executed.
- set_integration: Provide metadata about the integration.
zig build test --summary all
or
just test