aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
index 42fbe2f..5df79ad 100644
--- a/README.md
+++ b/README.md
@@ -30,6 +30,36 @@ After building, you can run the "test suite" (depends on Pytest).
make test
+### Code coverage
+
+You can generate a code coverage report (depends on `gcovr`) in
+build/coverage/:
+
+ make coverage
+
+The latest code coverage report for the `master` branch can be found at
+https://egor-tensin.github.io/cimple/coverage/.
+
+### Flame graphs
+
+Some performance analysis can be done by looking at flame graphs.
+Generate them after building the project (depends on `perf` & [FlameGraph]):
+
+ make test/perf
+
+[FlameGraph]: https://github.com/brendangregg/FlameGraph
+
+This will generate two flame graphs in build/flame_graphs/; they stress
+slightly different parts of the system:
+
+* [flame_graph_output_simple.svg] for a CI script with short output,
+* [flame_graph_output_long.svg] for a CI script with long output.
+
+[flame_graph_output_simple.svg]: https://egor-tensin.github.io/cimple/flame_graphs/flame_graph_output_simple.svg
+[flame_graph_output_long.svg]: https://egor-tensin.github.io/cimple/flame_graphs/flame_graph_output_long.svg
+
+Follow the links above to view the latest flame graphs for the `master` branch.
+
### Code style
Set up the git pre-commit hook by running `./scripts/setup-hooks.sh`.