Guides in this folder go deeper than the root README. Start there for the overview and quickstart; use these pages when you need full detail.
Working example project: equilibrium-test — clone and run to see the annotations in action.
| Guide | What it covers |
|---|---|
| Why Project Equilibrium? | Benefits, when to use it, when to pick something else |
| Quickstart | Minimal Maven setup and first generated DTO |
| How it works | Annotation processing, compile-time safety, no reflection |
| Build tooling | Full Maven compiler snippet, IDE notes, Gradle orientation |
| Configuration | -Aequilibrium.* options, precedence, compile banner |
| Annotations reference | @GenerateDto / @GenerateRecord / @GenerateVo, ignores, nesting, experimental validation |
| Ecosystem | MapStruct and other complementary tools |
| DTO builder pattern | @GenerateDto(builder=true), @DtoBuilderDefault, Lombok |
| Experimental validation | @ValidateDto / @ValidateRecord / @ValidateVo |
| DTOs and interfaces (wrapper pattern) | Serializable, Comparable, etc. |
| Custom fields and methods on generated DTOs | Subclassing, helpers, equals / hashCode |
| Troubleshooting and pitfalls | Common failure paths, IDE/build issues, ignores, nesting, processors, GPL pointer |