BigfootDev/flatbuffers
1
0
Fork 1
mirror of https://github.com/google/flatbuffers.git synced 2026-06-27 12:52:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

WIP: Dart release 2.0 (#6927)

Browse Source 
* chore: make flatc artifacts from CI executable

* chore: prepare dart 2.0.0 release

* refactor: update description in pubspec.yaml to make pub.dev happy

"The package description is too long.
Search engines display only the first part of the description. Try to keep the value of the description field in your package's pubspec.yaml file between 60 and 180 characters."
This commit is contained in:
Ivan Dlugos
2021-11-18 19:56:29 +01:00
committed by GitHub
parent a59288a019
commit 256ab3798d
4 changed files with 34 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
dart/README.md
View File

@@ -1,13 +1,17 @@
# FlatBuffers for Dart
This package is used to read and write FlatBuffer files in Dart.
This package is used to read and write [FlatBuffers](https://google.github.io/flatbuffers/).
Most consumers will want to use the [`flatc`](https://github.com/google/flatbuffers)
compiler to generate Dart code from a FlatBuffers IDL schema. For example, the
`monster_my_game.sample_generated.dart` was generated with `flatc` from
`monster.fbs` in the example folder. The generated classes can be used to read
or write binary files that are interoperable with other languages and platforms
supported by FlatBuffers, as illustrated in the `example.dart` in the
Most consumers will want to use the [`flatc` - FlatBuffer compiler](https://github.com/google/flatbuffers) binary for your platform:
* [Linux](https://github.com/google/flatbuffers/suites/4363603985/artifacts/114682272)
* [macOS](https://github.com/google/flatbuffers/suites/4363603985/artifacts/114682273)
* [Windows](https://github.com/google/flatbuffers/suites/4363603985/artifacts/114682274)
The FlatBuffer compiler `flatc` reads a FlatBuffers IDL schema and generates Dart code.
The generated classes can be used to read or write binary data/files that are interoperable with
other languages and platforms supported by FlatBuffers, as illustrated in the `example.dart` in the
examples folder.
Additional documentation and examples are available [at the FlatBuffers site](https://google.github.io/flatbuffers/index.html)
For more details and documentation, head over to the official site and read the
[Tutorial](https://google.github.io/flatbuffers/flatbuffers_guide_tutorial.html) and how to
[use FlatBuffers in Dart](https://google.github.io/flatbuffers/flatbuffers_guide_use_dart.html).