From 374fb6a84cb454d916d6908c423194089e833b2b Mon Sep 17 00:00:00 2001 From: DemchaAV Date: Sun, 12 Jul 2026 10:14:53 +0100 Subject: [PATCH] docs(readme): add a repository module map MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The README explained which artifact to depend on but not how the repository itself is organised. Add a Modules subsection under Architecture: the published Maven Central coordinates (engine in core/, render backends, templates, testing, the graph-compose wrapper + bundle), the independently-versioned fonts/emoji companions, and the development-only modules (qa, coverage, examples, benchmarks), plus the one-line build story — root pom is the reactor aggregator, ./mvnw clean verify builds every module, -pl : scopes to one. --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index c8e6bcbe..b526c46b 100644 --- a/README.md +++ b/README.md @@ -301,6 +301,21 @@ flowchart LR Full detail: [architecture overview](./docs/architecture/overview.md) · [package map](./docs/architecture/package-map.md) · [lifecycle](./docs/architecture/lifecycle.md). +### Modules + +The repository is a Maven multi-module reactor: the root `pom.xml` is the build aggregator, so `./mvnw clean verify` at the root builds and tests **every** module (scope to one with `-pl :`; the lean engine lives in `core/`). + +- **Published to Maven Central** + - `graph-compose-core` (`core/`) — the lean document engine + - `graph-compose-render-pdf` · `-render-docx` · `-render-pptx` — render backends + - `graph-compose-templates` — built-in CV / cover-letter / invoice / proposal presets + - `graph-compose-testing` — snapshot & visual-regression test helpers + - `graph-compose` — the drop-in wrapper (core + PDF); `graph-compose-bundle` — batteries-included (adds templates + fonts + emoji) +- **Companion artifacts** (independent version lines) — `graph-compose-fonts`, `graph-compose-emoji` +- **Development only** (never published) — `qa` (architecture guards + visual regression), `coverage` (aggregate JaCoCo), `examples`, `benchmarks` + +See [CONTRIBUTING](./CONTRIBUTING.md) for the branch-routing table and the full build / verify flow. + ## Documentation 📚 **[Full docs index](./docs/README.md)** — categorised map of every doc, ADR, and recipe. Start there to navigate the documentation.