From ac5b87d6a80346665604473b7a644a5bdb15fa41 Mon Sep 17 00:00:00 2001 From: Scott McKendry <39483124+scottmckendry@users.noreply.github.com> Date: Fri, 17 Nov 2023 10:03:45 +1300 Subject: [PATCH] Add disclaimer about benchmarks to readme --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 07b123c..628a6af 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,10 @@ All my solutions to the [Advent of Code](https://adventofcode.com/) challenges, ![img](https://media.tenor.com/0hKphDvj4QAAAAAC/grinch-waiting-grinch.gif) +> [!NOTE] +> Benchmarks are run via [this GitHub Action](https://github.com/scottmckendry/aoc/actions/workflows/readmeStats.yml) and are not indicative of the performance of the code on your machine. +> The action uses the `ubuntu-latest` image, and runs each solution 100 times to get an average. This is by no means a perfect benchmark, so take the results below with a grain of salt. + ## 2022 | Day | Part 1 | Part 2 | Stars |