Update README.md #213
Merged
Update README.md #213
+84
−60
Conversation
This file contains 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-off-by: Sharan Gowda <[email protected]> Updated the Readme file based on my understanding.
goneall
approved these changes
Jul 16, 2021
There was a problem hiding this comment.
Changes to the README LGTM.
The README is starting to get a bit long for a top level README.
You may want to split it into 2 or 3 README's. The top level README would cover the most used use case of installing and running the spdx-sbom-generator.
A separate README could cover developing plugins (e.g. README-PLUGINS.md) and link to the separate README from the top level README.
A potential 3rd could cover building the project from source - although that may be small enough to include in the top level README.
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.
Sign-off-by: Sharan Gowda [email protected]
Updated the Readme file based on my understanding.