|
| 1 | +# Generated Project README Previews |
| 2 | + |
| 3 | +This document showcases **real, generated README outputs** produced by Codegen Blueprint. |
| 4 | + |
| 5 | +It exists to make one thing explicit: |
| 6 | + |
| 7 | +> **Codegen Blueprint does not only generate code — it generates a complete, opinionated project contract.** |
| 8 | +
|
| 9 | +The README files shown here are **not hand-written examples**. |
| 10 | +They are the **exact README.md files generated into projects** created via the CLI. |
| 11 | + |
| 12 | +--- |
| 13 | + |
| 14 | +## Why this matters |
| 15 | + |
| 16 | +Most generators stop at code scaffolding. |
| 17 | +Codegen Blueprint goes further by generating: |
| 18 | + |
| 19 | +* a **clear project identity** (what was generated, how, and why) |
| 20 | +* an explicit **architecture contract** (layout + enforcement) |
| 21 | +* a **deterministic onboarding path** (how to build, run, and explore) |
| 22 | + |
| 23 | +The generated README is therefore part of the **product output**, not auxiliary documentation. |
| 24 | + |
| 25 | +--- |
| 26 | + |
| 27 | +## What you are seeing |
| 28 | + |
| 29 | +Below are two generated README examples created from the **same engine**, using the **same enforcement mode**, but with **different architectural models**: |
| 30 | + |
| 31 | +| Variant | Layout | Enforcement | Sample Code | |
| 32 | +| --------- | ---------------- | ----------- | ----------- | |
| 33 | +| Hexagonal | Ports & Adapters | strict | basic | |
| 34 | +| Standard | Layered | strict | basic | |
| 35 | + |
| 36 | +Both projects: |
| 37 | + |
| 38 | +* were generated via the CLI |
| 39 | +* compile and pass `mvn verify` |
| 40 | +* include executable ArchUnit enforcement rules |
| 41 | +* fail the build when architectural boundaries are violated |
| 42 | + |
| 43 | +--- |
| 44 | + |
| 45 | +## Hexagonal Architecture — Generated README |
| 46 | + |
| 47 | +This README was generated using: |
| 48 | + |
| 49 | +```bash |
| 50 | +--layout hexagonal --enforcement strict --sample-code basic |
| 51 | +``` |
| 52 | + |
| 53 | +Key characteristics visible in the generated README: |
| 54 | + |
| 55 | +* Explicit declaration of **hexagonal (ports & adapters) architecture** |
| 56 | +* Clear explanation of **inbound / outbound boundaries** |
| 57 | +* Strict enforcement guarantees: |
| 58 | + |
| 59 | + * ports isolation |
| 60 | + * adapter direction rules |
| 61 | + * domain purity |
| 62 | +* Exact location of generated ArchUnit rules |
| 63 | +* Runnable, minimal sample demonstrating correct dependency flow |
| 64 | + |
| 65 | +📄 **Full generated README:** |
| 66 | + |
| 67 | +→ [Hexagonal Project README.md](./generated/hexagonal/README.md) |
| 68 | + |
| 69 | +--- |
| 70 | + |
| 71 | +## Standard (Layered) Architecture — Generated README |
| 72 | + |
| 73 | +This README was generated using: |
| 74 | + |
| 75 | +```bash |
| 76 | +--layout standard --enforcement strict --sample-code basic |
| 77 | +``` |
| 78 | + |
| 79 | +Key characteristics visible in the generated README: |
| 80 | + |
| 81 | +* Explicit declaration of **standard layered architecture** |
| 82 | +* Clear explanation of layer responsibilities |
| 83 | +* Strict enforcement guarantees: |
| 84 | + |
| 85 | + * controller → service → repository direction |
| 86 | + * domain purity |
| 87 | + * REST boundary isolation |
| 88 | +* Deterministic failure behavior on violations |
| 89 | +* Simple, readable sample designed for baseline understanding |
| 90 | + |
| 91 | +📄 **Full generated README:** |
| 92 | + |
| 93 | +→ [Standard Project README.md](./generated/standard/README.md) |
| 94 | + |
| 95 | +--- |
| 96 | + |
| 97 | +## What this proves |
| 98 | + |
| 99 | +These READMEs demonstrate that: |
| 100 | + |
| 101 | +* Architecture is **declared**, not implied |
| 102 | +* Enforcement is **explicit**, not hidden |
| 103 | +* Generated projects are **self-explanatory** |
| 104 | +* Onboarding does not require tribal knowledge |
| 105 | + |
| 106 | +Most importantly: |
| 107 | + |
| 108 | +> The generated README is part of the **architecture contract**. |
| 109 | +
|
| 110 | +It documents exactly what the generator promised — and what the build will enforce. |
| 111 | + |
| 112 | +--- |
| 113 | + |
| 114 | +## Relationship to Executable Architecture Proof |
| 115 | + |
| 116 | +If you want to see **how these guarantees are enforced**, step by step, including: |
| 117 | + |
| 118 | +* clean baseline builds |
| 119 | +* intentional violations |
| 120 | +* deterministic build failures |
| 121 | + |
| 122 | +see: |
| 123 | + |
| 124 | +→ **Executable Architecture Proof — Architecture Enforcement Walkthrough** |
| 125 | + |
| 126 | +This document shows the **proof**. |
| 127 | +The READMEs shown here represent the **resulting product**. |
| 128 | + |
| 129 | +--- |
| 130 | + |
| 131 | +## Summary |
| 132 | + |
| 133 | +Codegen Blueprint generates: |
| 134 | + |
| 135 | +* architecture-aware code |
| 136 | +* executable architectural guardrails |
| 137 | +* **first-class project documentation** |
| 138 | + |
| 139 | +The README is not an afterthought. |
| 140 | +It is part of the generated system. |
| 141 | + |
| 142 | +> **Architecture as a Product** starts with what the user sees first. |
0 commit comments