Skip to content

Commit f2333f4

Browse files
authored
Update README.md
1 parent 085ae67 commit f2333f4

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

html-generators/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,16 @@ This folder contains the build scripts that generate all HTML detail pages and `
44

55
## Files
66

7-
| File | Description |
8-
|------|-------------|
9-
| `generate.java` | JBang script (Java 25) — primary generator |
10-
| `generate.py` | Python equivalent — produces identical output |
11-
| `generate.jar` | Pre-built fat JAR (no JBang/JDK setup needed) |
12-
| `build-cds.sh` | Script to build a platform-specific AOT cache |
7+
| File | Description |
8+
|-----------------|-----------------------------------------------|
9+
| `generate.java` | JBang script (Java 25) — primary generator |
10+
| `generate.py` | Python equivalent — produces identical output |
11+
| `generate.jar` | Pre-built fat JAR (no JBang/JDK setup needed) |
12+
| `build-cds.sh` | Script to build a platform-specific AOT cache |
13+
14+
## Benchmark
15+
16+
See [BENCHMARK.md](BENCHMARK.md) for performance comparisons across all four execution methods (AOT, Fat JAR, JBang, Python).
1317

1418
## Running
1519

@@ -68,7 +72,3 @@ Two GitHub Actions workflows automate the build and deploy pipeline:
6872
2. **`deploy.yml`** — Triggered when content, templates, the JAR, or site assets change on `main`. Runs `java -jar html-generators/generate.jar` to regenerate all HTML pages, `snippets.json`, and `index.html`, then deploys the `site/` folder to GitHub Pages.
6973

7074
This means the deploy workflow always uses the pre-built fat JAR (no JBang required at deploy time), and the JAR stays in sync with the source automatically.
71-
72-
## Benchmark
73-
74-
See [BENCHMARK.md](BENCHMARK.md) for performance comparisons across all four execution methods (AOT, fat JAR, JBang, Python).

0 commit comments

Comments
 (0)