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 #529
2 files changed
tree: 4236e8493f03ff5fd051f27555b2c734f08db358
  1. .github/
  2. api_benchmark/
  3. protobuf/
  4. protoc_plugin/
  5. query_benchmark/
  6. tool/
  7. .gitignore
  8. analysis_options.yaml
  9. mono_repo.yaml
  10. README.md
README.md

Protobuf support for Dart

CI status pub package

Protocol 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: