Expand example documentation #2570
Merged
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
- Clean up some markup - Document pre-reqs. - Document all make targets. - Avoid the $BINARY because it looks like a bash variable. - Expand intro
crisidev
reviewed
Apr 12, 2023
hlbarber
added
documentation
Co-authored-by: Matteo Bigoi <[email protected]>
timClicks
commented
Apr 19, 2023
crisidev
approved these changes
Apr 21, 2023
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
david-perez
reviewed
Apr 24, 2023
david-perez
reviewed
Apr 24, 2023
unexge
pushed a commit
that referenced
this pull request
Apr 24, 2023
## Motivation and Context The current README for the example services is fairly spartan. ## Description I've expanded the README, specifically: - Clean up some markup - Document pre-reqs. - Document all make targets. - Avoid the $BINARY because it looks like a bash variable. - Expand intro ## Testing <!--- Please describe in detail how you tested your changes --> <!--- Include details of your testing environment, and the tests you ran to --> <!--- see how your change affects other areas of the code, etc. --> n/a ## Checklist n/a ---- _By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice._ --------- Co-authored-by: Matteo Bigoi <[email protected]> Co-authored-by: david-perez <[email protected]>
rcoh
pushed a commit
that referenced
this pull request
Apr 24, 2023
## Motivation and Context The current README for the example services is fairly spartan. ## Description I've expanded the README, specifically: - Clean up some markup - Document pre-reqs. - Document all make targets. - Avoid the $BINARY because it looks like a bash variable. - Expand intro ## Testing <!--- Please describe in detail how you tested your changes --> <!--- Include details of your testing environment, and the tests you ran to --> <!--- see how your change affects other areas of the code, etc. --> n/a ## Checklist n/a ---- _By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice._ --------- Co-authored-by: Matteo Bigoi <[email protected]> Co-authored-by: david-perez <[email protected]>
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.
Motivation and Context
The current README for the example services is fairly spartan.
Description
I've expanded the README, specifically:
Testing
n/a
Checklist
n/a
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.