Rewrite README with usage, status and version guidance - #491
Merged
Conversation
The README was badges, one sentence, and a pointer to the Error Prone docs. It did not list the modules, so a reader had no way to know which of the seven artifacts to depend on. Adds a module table, a dependency snippet for the API, the Java baseline and documentation links, and explains that consumers normally select a compiler through maven-compiler-plugin's compilerId rather than depending on these artifacts directly. 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
1 participant
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.
This repo publishes seven artifacts and the README listed none of them, so a reader had no way to work out which one to depend on. It now has a module table:
plexus-compiler-apiCompilerinterface — depend on this to write against the APIplexus-compiler-managerplexus-compiler-javacplexus-compiler-eclipseplexus-compiler-javac-errorproneplexus-compiler-aspectjplexus-compiler-csharpIt also makes a distinction the old README did not: most people should not depend on these directly. To use a non-default compiler you set
<compilerId>onmaven-compiler-pluginand add the implementation to that plugin's dependencies. Linked to the Maven page that explains it.The existing Error Prone pointer and the link to the integration test are kept — both still resolve.
While writing this I first linked
…/examples/non-javac-compilers.html, which 404s; the correct URL has noexamples/segment. Both links in the final version are checked.Ran
mvn spotless:apply.