| commit | d232e6e3f68c92a706689cac51bf916f3b083bca | [log] [tgz] |
|---|---|---|
| author | Ömer Sinan Ağacan <omersa@google.com> | Wed Apr 20 09:35:13 2022 +0200 |
| committer | GitHub <noreply@github.com> | Wed Apr 20 09:35:13 2022 +0200 |
| tree | 4236e8493f03ff5fd051f27555b2c734f08db358 | |
| parent | 0f01fa99c902d94fa6cd3c154a3e31c0d3365718 [diff] |
Tweak READMEs: (#610)
- 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 #576:
- For each installation method clarify whether they generate a Dart
script or standalone native executable.
- Addresses: #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 #576
Fixes #529Protocol Buffers (protobuf) are Google's language-neutral, platform-neutral, extensible mechanism for serializing structured data.
This repository is home to packages related to protobuf for Dart. It contains: