Skip to content

Commit c24f08a

Browse files
brunoborgesCopilot
andcommitted
Update README with current architecture and i18n info
- Update snippet count badge from 107 to 112 - Add translations and i18n section to architecture - Fix generator description (JBang script, not fat JAR) - Add link to i18n spec - List all 9 supported languages Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent ae5a7ea commit c24f08a

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ A collection of side-by-side code comparisons showing old Java patterns next to
77
🔗 **[javaevolved.github.io](https://javaevolved.github.io)**
88

99
[![GitHub Pages](https://img.shields.io/badge/GitHub%20Pages-live-brightgreen)](https://javaevolved.github.io)
10-
[![Snippets](https://img.shields.io/badge/snippets-107-blue)](#categories)
10+
[![Snippets](https://img.shields.io/badge/snippets-112-blue)](#categories)
1111
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
1212
[![Contributions welcome](https://img.shields.io/badge/contributions-welcome-orange)](#contributing)
1313

@@ -42,14 +42,19 @@ Each comparison includes an explanation of *why* the modern approach is better,
4242

4343
## Architecture
4444

45-
This site uses a **JSON-first** build pipeline:
45+
This site uses a **JSON/YAML-first** build pipeline:
4646

47-
- **Source of truth**: Individual `content/category/slug.json` files (107 across 11 category folders)
48-
- **Templates**: `templates/` — shared HTML templates with `{{placeholder}}` tokens
49-
- **Generator**: `html-generators/generate.jar` — pre-built fat JAR that produces all HTML detail pages and `data/snippets.json`
47+
- **Source of truth**: Individual `content/category/slug.json` files (112 patterns across 11 category folders)
48+
- **Templates**: `templates/` — shared HTML templates with `{{placeholder}}` tokens for content and UI strings
49+
- **Generator**: `html-generators/generate.java` — JBang script that produces all HTML pages, localized variants, and `data/snippets.json`
50+
- **Translations**: `translations/strings/{locale}.yaml` for UI strings, `translations/content/{locale}/` for pattern content (YAML)
5051
- **Deploy**: GitHub Actions runs the generator and deploys to GitHub Pages
5152

52-
Generated files (`site/category/*.html` and `site/data/snippets.json`) are in `.gitignore` — never edit them directly.
53+
Generated files (`site/category/*.html`, `site/{locale}/`, and `site/data/snippets.json`) are in `.gitignore` — never edit them directly.
54+
55+
### Internationalization
56+
57+
The site supports 9 languages: English, Deutsch, Español, Português (Brasil), 中文 (简体), العربية, Français, 日本語, and 한국어. See [`specs/i18n/i18n-spec.md`](specs/i18n/i18n-spec.md) for the full specification.
5358

5459
## Build & run locally
5560

@@ -68,7 +73,7 @@ jwebserver -b 0.0.0.0 -d site -p 8090
6873
# Open http://localhost:8090
6974
```
7075

71-
The fat JAR is a self-contained ~2.2 MB file with all dependencies bundled. No JBang installation needed.
76+
The fat JAR is a self-contained ~2.2 MB file with all dependencies bundled. [JBang](https://jbang.dev) is needed to run the generator.
7277

7378
For development on the generator itself, you can use JBang or Python — see [html-generators/README.md](html-generators/README.md) for details.
7479

0 commit comments

Comments
 (0)