Skip to content

Commit 8418580

Browse files
brunoborgesCopilot
andcommitted
Rename benchmark/BENCHMARK.md to benchmark/README.md
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent f8eb981 commit 8418580

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

html-generators/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This folder contains the build scripts that generate all HTML detail pages and `
1313

1414
## Benchmark
1515

16-
See [BENCHMARK.md](benchmark/BENCHMARK.md) for performance comparisons across all four execution methods (AOT, Fat JAR, JBang, Python).
16+
See [benchmark/README.md](benchmark/README.md) for performance comparisons across all four execution methods (AOT, Fat JAR, JBang, Python).
1717

1818
## Running
1919

html-generators/benchmark/run.sh

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
#
44
# Setup: rebuilds the AOT cache before benchmarking.
55
# Runs: 6 iterations per method (1 cold + 5 warm).
6-
# Output: table printed to stdout; optionally updates BENCHMARK.md.
6+
# Output: table printed to stdout; optionally updates README.md.
77
#
88
# Usage:
99
# ./html-generators/benchmark/run.sh # run all methods
10-
# ./html-generators/benchmark/run.sh --update # also update BENCHMARK.md
10+
# ./html-generators/benchmark/run.sh --update # also update README.md
1111

1212
set -euo pipefail
1313
cd "$(git rev-parse --show-toplevel)"
@@ -39,7 +39,7 @@ bench() {
3939
local warm
4040
warm=$(echo "scale=2; $sum / ($RUNS - 1)" | bc | sed 's/^\./0./')
4141
printf "| %-42s | %5ss | **%5ss** |\n" "$label" "$cold" "$warm"
42-
# export for BENCHMARK.md update
42+
# export for README.md update
4343
eval "${2//[^a-zA-Z]/_}_COLD=$cold"
4444
eval "${2//[^a-zA-Z]/_}_WARM=$warm"
4545
}
@@ -128,10 +128,10 @@ printf "| %-42s | %5ss | **%5ss** |\n" "**Python** (\`python3 generate.py\`)" "$
128128
echo ""
129129

130130
# ---------------------------------------------------------------------------
131-
# Optionally update BENCHMARK.md
131+
# Optionally update README.md
132132
# ---------------------------------------------------------------------------
133133
if $UPDATE_MD; then
134-
MD="html-generators/benchmark/BENCHMARK.md"
134+
MD="html-generators/benchmark/README.md"
135135
cat > "$MD" <<EOF
136136
# Generator Benchmarks
137137

0 commit comments

Comments
 (0)