mirror of
https://github.com/google/flatbuffers.git
synced 2026-06-06 21:37:36 +00:00
69a31b807a
Adding an API reference for the supported languages. General docs cleanup, including a new `tutorial` section that supports all of the supported languages. Added samples for each supported language to mirror the new tutorial page. Cleaned up all the links by making them `@ref` style links, instead of referencing the names of the generated `.html` files. Removed all generated files that were unnecessarily committed. Also fixed the C# tests (two were failing due to a missing file). Bug: b/25801305 Tested: Tested all samples on Ubuntu, Mac, and Android. Docs were generated using doxygen and viewed on Chrome. Change-Id: I2acaba6e332a15ae2deff5f26a4a25da7bd2c954
42 lines
1.8 KiB
Markdown
Executable File
42 lines
1.8 KiB
Markdown
Executable File
FlatBuffers Version 1.2.0
|
|
|
|
# Welcome to FlatBuffers!
|
|
|
|
## Build Status
|
|
|
|
- Travis: [](https://travis-ci.org/google/flatbuffers)
|
|
|
|
----
|
|
|
|
FlatBuffers is a serialization library for games and other memory constrained
|
|
apps. Go to our [landing page][] to browse our documentation.
|
|
|
|
FlatBuffers allows you to directly access serialized data without
|
|
unpacking/parsing it first, while still having great forwards/backwards
|
|
compatibility. FlatBuffers can be built for many different systems (Android,
|
|
Windows, OS X, Linux), see `docs/html/index.html`
|
|
|
|
Discuss FlatBuffers with other developers and users on the
|
|
[FlatBuffers Google Group][]. File issues on the [FlatBuffers Issues Tracker][]
|
|
or post your questions to [stackoverflow.com][] using the [`flatbuffers` tag][].
|
|
|
|
To contribute to this project, see [CONTRIBUTING][].
|
|
|
|
For applications on Google Play that integrate this tool, usage is tracked.
|
|
This tracking is done automatically using the embedded version string
|
|
(flatbuffer_version_string), and helps us continue to optimize it. Aside from
|
|
consuming a few extra bytes in your application binary, it shouldn't affect
|
|
your application at all. We use this information to let us know if FlatBuffers
|
|
is useful and if we should continue to invest in it. Since this is open
|
|
source, you are free to remove the version string but we would appreciate if
|
|
you would leave it in.
|
|
|
|
<br>
|
|
|
|
[CONTRIBUTING]: http://github.com/google/flatbuffers/blob/master/CONTRIBUTING
|
|
[`flatbuffers` tag]: https://stackoverflow.com/questions/tagged/flatbuffers
|
|
[FlatBuffers Google Group]: http://group.google.com/group/flatbuffers
|
|
[FlatBuffers Issues Tracker]: http://github.com/google/flatbuffers/issues
|
|
[stackoverflow.com]: http://www.stackoverflow.com
|
|
[landing page]: http://google.github.io/flatbuffers
|