Skip to content

Rewrite README with usage, status and version guidance - #579

Merged
slachiewicz merged 1 commit into
masterfrom
docs/readme
Aug 8, 2026
Merged

Rewrite README with usage, status and version guidance#579
slachiewicz merged 1 commit into
masterfrom
docs/readme

Conversation

@slachiewicz

Copy link
Copy Markdown
Member

Part of codehaus-plexus/.github#58. Same skeleton as the merged pilots — the last of the thirteen.

The old README explained what Modello is quite well, then gave you a command for building its own site. It never showed how to use it.

For a build-time code generator, the plugin configuration is the thing people come for, so that is now in the README:

<plugin>
  <groupId>org.codehaus.modello</groupId>
  <artifactId>modello-maven-plugin</artifactId>
  …
  <goals>
    <goal>java</goal>
    <goal>xpp3-reader</goal>
    <goal>xpp3-writer</goal>
    <goal>xsd</goal>
  </goals>

With the point that each goal is a generator and you pick the ones you need — which is not obvious from a list of ten plugin modules.

Also adds a one-paragraph summary of what can be generated (XML via five APIs, YAML via two, JSON Schema, XSD, xdoc, converters, Velocity templates since 2.1.0), the Java baseline, and the -Prun-its note for contributors.

The MIT licensing note is kept and given its own section — it is the one project here that is not Apache-2.0, and that is worth not burying.

The site-generation command is dropped; publishing is documented once in RELEASING.md.

Ran mvn spotless:apply.

The README described what Modello is but never showed how to use it.
For a build-time code generator the plugin configuration is the thing
people need, so it is now in the README rather than only on the site.

Adds a plugin snippet with a representative goal set, a summary of the
available generators, the Java baseline, and the note that integration
tests run under -Prun-its.

Keeps the MIT licensing note, which matters because everything else in
the organisation is Apache-2.0.

Replaces the site-generation command, which described how to build the
site rather than how to use the tool; publishing is documented once in
RELEASING.md.

Part of codehaus-plexus/.github#58
@slachiewicz slachiewicz added the documentation Documentation and site content label Aug 8, 2026
@slachiewicz
slachiewicz merged commit 720e9de into master Aug 8, 2026
12 checks passed
@slachiewicz
slachiewicz deleted the docs/readme branch August 8, 2026 19:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation and site content

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant