Fix Sample Readme #838
Merged
Fix Sample Readme #838
Conversation
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
sbSteveK
reviewed
Oct 17, 2025
| ```sh | ||
| .mqtt5_aws_websocket \ | ||
| cd build | ||
| ./mqtt5_aws_websocket \ |
There was a problem hiding this comment.
Trivial: the description says "To run this sample from the folder". Instead of cd build should we just provide the command build/mqtt5_aws_websocket which is to run the sample from the sample folder?
There was a problem hiding this comment.
I would like to remove the build from the final command as the user might build in a different folder. I updated the instruction to the following. Hope this make more sense.
To run this sample, navigate to the build directory where the executable was created:
# From samples/mqtt/mqtt5_aws_websocket/, go to the build directory cd build ./mqtt5_aws_websocket \ --endpoint <AWS IoT endpoint> \ --signing_region <Signing region for websocket connection>
sbSteveK
reviewed
Oct 17, 2025
sbSteveK
approved these changes
Oct 17, 2025
sfod
reviewed
Oct 17, 2025
sfod
approved these changes
Oct 20, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Issue #, if available:
Description of changes:
cd buildusage disclaimerfor service clients samples.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.