record: introduce directory for saving results

This in particular establishes a baseline for both binary size and
compilation time for regex 1.7.3, which is before any of the changes for
regex-automata.

record/README.md

@@ -0,0 +1,4 @@
+This directory contains various recordings of results. These are committed to
+the repository so that they can be compared over time. (At the time of writing,
+there is no tooling for facilitating this comparison. It has to be done
+manually.)

record/compile-test/2023-04-19_1.7.3.csv

@@ -0,0 +1,11 @@
+name,crate,revision,profile,duration,size,relative-size
+regex__dev__std_perf_unicode,regex,9582040009,dev,1.824209152s,3434992,3113064
+regex__dev__std,regex,9582040009,dev,1.206314935s,1362392,1040464
+regex__dev__std_perf,regex,9582040009,dev,1.543583435s,2726384,2404456
+regex__dev__std_unicode,regex,9582040009,dev,1.490095643s,2066904,1744976
+regex__dev__std_unicode-case_unicode-perl,regex,9582040009,dev,1.292011694s,1812952,1491024
+regex__release__std_perf_unicode,regex,9582040009,release,2.398133563s,1616216,1294368
+regex__release__std,regex,9582040009,release,1.413680252s,694592,372744
+regex__release__std_perf,regex,9582040009,release,2.341496191s,1124696,802848
+regex__release__std_unicode,regex,9582040009,release,1.671407822s,1190208,868360
+regex__release__std_unicode-case_unicode-perl,regex,9582040009,release,1.441712198s,932160,610312

record/compile-test/README.md

@@ -0,0 +1,27 @@
+This directory contains the results of compilation tests. Specifically,
+the results are from testing both the from scratch compilation time and
+relative binary size increases of various features for both the `regex` and
+`regex-automata` crates.
+
+Here's an example of how to run these tests for just the `regex` crate. You'll
+need the `regex-cli` command installed, which can be found in the `regex-cli`
+directory in the root of this repository.
+
+This must be run in the root of a checkout of this repository.
+
+```
+$ mkdir /tmp/regex-compile-test
+$ regex-cli compile-test ./ /tmp/regex-compile-test | tee record/compile-test/2023-04-19_1.7.3.csv
+```
+
+You can then look at the results using a tool like [`xsv`][xsv]:
+
+```
+$ xsv table record/compile-test/2023-04-19_1.7.3.csv
+```
+
+Note that the relative binary size is computed by building a "baseline" hello
+world program, and then subtracting that from the size of a binary that uses
+the regex crate.
+
+[xsv]: https://github.com/BurntSushi/xsv