diff --git a/.gitignore b/.gitignore index 9e187a34a9606..aa7009af14855 100644 --- a/.gitignore +++ b/.gitignore @@ -14,6 +14,7 @@ valgrind_ctime_test *.exe *.so *.a +*.csv !.gitignore Makefile diff --git a/README.md b/README.md index 182c29d9ce5ef..7499f84d42065 100644 --- a/README.md +++ b/README.md @@ -100,6 +100,18 @@ To create a HTML report with coloured and annotated source code: $ mkdir -p coverage $ gcovr --exclude 'src/bench*' --html --html-details -o coverage/coverage.html +Benchmark +------------ +If configured with `--enable-benchmark` (which is the default), binaries for benchmarking the libsecp256k1 functions will be present in the root directory after the build. + +To print the benchmark result to the command line: + + $ ./bench_name + +To create a CSV file for the benchmark result : + + $ ./bench_name | sed '2d;s/ \{1,\}//g' > bench_name.csv + Reporting a vulnerability ------------