Rewrite README with usage, status and version guidance - #579
Merged
Conversation
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
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-itsnote 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.