Skip to content

Commit d4478a7

Browse files
committed
Update README.md
1 parent 0b383b6 commit d4478a7

2 files changed

Lines changed: 11 additions & 1 deletion

File tree

priv/partials/readme_content.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,16 @@ All commands should work from then on.
2626

2727
run `mix test` to ensure all solutions are working okay. To run test for a particular year and day, type `mix test --only y<last-two-digits-of-year><zero-padded-day>`. For example: `mix test --only y1501` tests for `2015` as year and `1` as day.
2828

29+
## Benchmarking
30+
31+
To benchmark solutions and update the [Benchmarks](BENCHMARKS.md) report, use the provided script:
32+
33+
- `scripts/gen_benchmark.py`: Runs all solved problems across all years.
34+
- `scripts/gen_benchmark.py <year>`: Benchmarks all days for a specific year.
35+
- `scripts/gen_benchmark.py <year> <day>`: Benchmarks a single problem (useful after a new solve).
36+
37+
The script saves results to a persistent JSON file at `priv/data/benchmark.json`, allowing you to update specific results without re-running everything.
38+
2939
## Updating README and Stats
3040

3141
If you want to update the `README.md` (i.e. this file) please do not update `README.me` directly, instead update the static content (not stats related) on `priv/partials/readme_content.md` and then run `mix readme` to regenerate this file.

scripts/gen_wiki.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ def gen_stats_block(solutions, tag_map):
132132

133133
lines = [
134134
f"> **{total} problems solved** across **{len(all_years)} years**"
135-
f" — [Tags](wiki/tags/index.md) · [Difficulty](wiki/difficulty.md)\n\n",
135+
f" — [Tags](wiki/tags/index.md) · [Difficulty](wiki/difficulty.md) · [Benchmarks](BENCHMARKS.md)\n\n",
136136
f"**Years:** {year_links}\n\n",
137137
]
138138

0 commit comments

Comments
 (0)