Tweak READMEs: #610
Merged
Tweak READMEs: #610
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
- Fix typos - Shorten some long lines in markdown files using footnote-style markdown links - Use `#` header syntax instead of a mix of `#` and underscores: it's unclear whether `---` is smaller than `##` or not. Using `#` for all headers is also more consistent and makes it easier to read in markdown format (rather than in rendered). - Add syntax highlighting to Dart and proto code examples. - Split "How to build and use" section into "How to build" and "How to use" sections. - Move `dart pub activate` method up and make it the recommended way of installing the plugin. - Describe how to build standalone native executables for the plugin. - Addresses google#576: - For each installation method clarify whether they generate a Dart script or standalone native executable. - Addresses: google#529: - Mention that latest version of Dart may be needed. Older versions don't have `dart pub` command and can cause errors when following installation instructions. - Link to protoc_plugin pub.dev page in protobuf README. - Link to Dart installation instructions in protoc_plugin README. Fixes google#576 Fixes google#529
This was referenced Apr 13, 2022
kevmoo
approved these changes
Apr 19, 2022
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.
Fix typos
Shorten some long lines in markdown files using footnote-style
markdown links
Use
#header syntax instead of a mix of#and underscores: it'sunclear whether
---is smaller than##or not. Using#for allheaders is also more consistent and makes it easier to read in
markdown format (rather than in rendered).
Add syntax highlighting to Dart and proto code examples.
Split "How to build and use" section into "How to build" and "How to
use" sections.
Move
dart pub activatemethod up and make it the recommended way ofinstalling the plugin.
Describe how to build standalone native executables for the plugin.
Addresses protoc Plugin Build Instructions Clarification #576:
script or standalone native executable.
Addresses: Something to suggest about guide #529:
Mention that latest version of Dart may be needed. Older versions
don't have
dart pubcommand and can cause errors when followinginstallation instructions.
Link to protoc_plugin pub.dev page in protobuf README.
Link to Dart installation instructions in protoc_plugin README.
Fixes #576
Fixes #529