Update Example READMEs #2179
Merged
Update Example READMEs #2179
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
Motivation: The examples now use the Swift PM build plugin but the READMEs weren't updated to include the PROTOC_PATH. Modifications: - update READMEs Result: Better examples
gjcairo
reviewed
Jan 24, 2025
| ## Usage | ||
|
|
||
| Build and run the server using the CLI: | ||
|
|
||
| ```console | ||
| $ swift run echo serve | ||
| $ PROTOC_PATH=$(which protoc) swift run echo serve |
There was a problem hiding this comment.
Similar to the comment I left on the examples, should we mention (and/or link to the plugin docs) why setting this environment variable is required?
gjcairo
approved these changes
Jan 24, 2025
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:
The examples now use the Swift PM build plugin but the READMEs weren't updated to include the PROTOC_PATH.
Modifications:
Result:
Better examples