Rewrite README with usage, status and version guidance - #151
Merged
Conversation
Adds what the library does - realms as a directed graph rather than a hierarchy, which is how Maven isolates plugins - plus the launcher, a dependency snippet, the Java baseline and documentation links. The Backward Compatibility section is kept verbatim. It is the most valuable documentation in the organisation: it records why the legacy org.codehaus.classworlds package cannot be removed, which Sisu bytecode references it, and the PR that tried and had to be reverted. The skeleton is built around it rather than over it. Drops the 2015 'current master is now at' line. 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.
The Backward Compatibility section is kept verbatim — I diffed it to confirm. That section is the reason I picked this repo as the model when proposing the skeleton in the first place: it records why
org.codehaus.classworldscannot be removed, which Sisu bytecode references it, and the PR that tried and had to be reverted. The skeleton is built around it, not over it.What is added is the part that was missing: what the library actually does.
That was on the project site but not here, and "A class loader framework" (the POM description) does not convey it.
Plus the dependency snippet, Java baseline and doc links, and the 2015 redirect line removed.
Ran
mvn spotless:apply.