diff options
Diffstat (limited to 'benchmark/bench/README.md')
| -rw-r--r-- | benchmark/bench/README.md | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/benchmark/bench/README.md b/benchmark/bench/README.md new file mode 100644 index 000000000..9d3312880 --- /dev/null +++ b/benchmark/bench/README.md @@ -0,0 +1,7 @@ +# bench + +This `bench` folder contains different benchmarking files that you can run via `astro-benchmark <bench-file-name>`, e.g. `astro-benchmark memory`. Files that start with an underscore are not benchmarking files. + +Benchmarking files will run against a project to measure its performance, and write the results down as JSON in the `results` folder. The `results` folder is gitignored and its result files can be safely deleted if you're not using them. + +You can duplicate `_template.js` to start a new benchmark test. All shared utilities are kept in `_util.js`. |