Adjust README instructions with community feedback #21
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
Since we will presumably have more people using the pre-built version than locally building the tool to add features and fix bugs, we should put this information earlier in the README.
This commit adds more information on quickly and effectively using Maven. Also, I added ` ```sh` fences to code blocks for shell commands. I also added example of adding to shell configuration files.
david-waltermire
force-pushed
the
16-clarify-readme-instructions
branch
from
7e79016 to
13c6ae1
Compare
david-waltermire
approved these changes
Sep 14, 2024
david-waltermire
merged commit c106179
into
metaschema-framework:develop
2 checks passed
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.
Committer Notes
This PR includes changes to address feedback from community members in #16 and follow-on impressions in a FedRAMP Implementers meeting. If reviewed, approved, and merged, closes #16.
The two keys goals:
Add docs on how to configure the PATH make the tool readily usableThis was already done, I missed it on initial review of extant docs.All Submissions:
"?
Changes to Core Features:
Have you added an explanation of what your changes do and why you'd like us to include them?Have you written new tests for your core changes, as applicable?Have you included examples of how to use your new feature(s)?Have you updated all website and readme documentation affected by the changes you made?