flatbuffers/readme.md

![logo](http://google.github.io/flatbuffers/fpl_logo_small.png) FlatBuffers
===========

[![Join the chat at https://gitter.im/google/flatbuffers](https://badges.gitter.im/google/flatbuffers.svg)](https://gitter.im/google/flatbuffers?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Build Status](https://travis-ci.org/google/flatbuffers.svg?branch=master)](https://travis-ci.org/google/flatbuffers) [![Build status](https://ci.appveyor.com/api/projects/status/yg5idd2fnusv1n10?svg=true)](https://ci.appveyor.com/project/gwvo/flatbuffers)

**FlatBuffers** is a cross platform serialization library architected for
maximum memory efficiency. It allows you to directly access serialized data without parsing/unpacking it first, while still having great forwards/backwards compatibility.

**Go to our [landing page][] to browse our documentation.**

## Supported operating systems
* Windows
* MacOS X
* Linux
* Android
* And any others with a recent C++ compiler.

## Supported programming languages
* C++
* C#
* C
* Dart
* Go
* Java
* JavaScript
* Lobster
* Lua
* PHP
* Python
* Rust
* TypeScript

*and more in progress...*

## Contribution
* [FlatBuffers Google Group][] to discuss FlatBuffers with other developers and users.
* [FlatBuffers Issues Tracker][] to submit an issue.
* [stackoverflow.com][] with [`flatbuffers` tag][] for any questions regarding FlatBuffers.

*To contribute to this project,* see [CONTRIBUTING][].

## Licensing
*Flatbuffers* is licensed under the Apache License, Version 2.0. See [LICENSE][] for the full license text.

<br>

   [CONTRIBUTING]: http://github.com/google/flatbuffers/blob/master/CONTRIBUTING.md
   [`flatbuffers` tag]: https://stackoverflow.com/questions/tagged/flatbuffers
   [FlatBuffers Google Group]: https://groups.google.com/forum/#!forum/flatbuffers
   [FlatBuffers Issues Tracker]: http://github.com/google/flatbuffers/issues
   [stackoverflow.com]: http://stackoverflow.com/search?q=flatbuffers
   [landing page]: https://google.github.io/flatbuffers
   [LICENSE]: https://github.com/google/flatbuffers/blob/master/LICENSE.txt
Added AppVeyor CI. Change-Id: I01cf630026e25382b585785b471bad21153338f6 2016-07-28 00:34:00 +00:00			`![logo](http://google.github.io/flatbuffers/fpl_logo_small.png) FlatBuffers`
Update readme.md 2016-01-22 16:57:47 +00:00			`===========`
Add Gitter badge (#4075) 2016-11-02 21:05:31 +00:00
			`[![Join the chat at https://gitter.im/google/flatbuffers](https://badges.gitter.im/google/flatbuffers.svg)](https://gitter.im/google/flatbuffers?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)`
Added AppVeyor CI. Change-Id: I01cf630026e25382b585785b471bad21153338f6 2016-07-28 00:34:00 +00:00			`[![Build Status](https://travis-ci.org/google/flatbuffers.svg?branch=master)](https://travis-ci.org/google/flatbuffers) [![Build status](https://ci.appveyor.com/api/projects/status/yg5idd2fnusv1n10?svg=true)](https://ci.appveyor.com/project/gwvo/flatbuffers)`

Updated readme.md Change-Id: I9b0664a3bde44a4ee44ef0fd117d0e4bedc132d9 2018-09-21 17:42:00 +00:00			`FlatBuffers is a cross platform serialization library architected for`
			`maximum memory efficiency. It allows you to directly access serialized data without parsing/unpacking it first, while still having great forwards/backwards compatibility.`
Update readme.md 2016-01-22 16:57:47 +00:00
			`Go to our [landing page][] to browse our documentation.`

			`## Supported operating systems`
			`* Windows`
			`* MacOS X`
			`* Linux`
Updated readme.md Change-Id: I9b0664a3bde44a4ee44ef0fd117d0e4bedc132d9 2018-09-21 17:42:00 +00:00			`* Android`
			`* And any others with a recent C++ compiler.`
Added AppVeyor CI. Change-Id: I01cf630026e25382b585785b471bad21153338f6 2016-07-28 00:34:00 +00:00
Update readme.md 2016-01-22 16:57:47 +00:00			`## Supported programming languages`
			`* C++`
			`* C#`
Add C support in README, minor updates in other C doc 2016-03-26 08:22:56 +00:00			`* C`
Updated readme.md Change-Id: I9b0664a3bde44a4ee44ef0fd117d0e4bedc132d9 2018-09-21 17:42:00 +00:00			`* Dart`
Update readme.md 2016-01-22 16:57:47 +00:00			`* Go`
			`* Java`
			`* JavaScript`
Updated readme.md Change-Id: I9b0664a3bde44a4ee44ef0fd117d0e4bedc132d9 2018-09-21 17:42:00 +00:00			`* Lobster`
			`* Lua`
Update readme.md 2016-01-22 16:57:47 +00:00			`* PHP`
			`* Python`
readme.md: add Rust as a supported language 2018-09-04 06:38:41 +00:00			`* Rust`
Updated readme.md Change-Id: I9b0664a3bde44a4ee44ef0fd117d0e4bedc132d9 2018-09-21 17:42:00 +00:00			`* TypeScript`
Update readme.md 2016-01-22 16:57:47 +00:00
Updated readme.md Change-Id: I9b0664a3bde44a4ee44ef0fd117d0e4bedc132d9 2018-09-21 17:42:00 +00:00			`and more in progress...`
Update readme.md 2016-01-22 16:57:47 +00:00
Added AppVeyor CI. Change-Id: I01cf630026e25382b585785b471bad21153338f6 2016-07-28 00:34:00 +00:00			`## Contribution`
Update readme.md 2016-01-22 16:57:47 +00:00			`* [FlatBuffers Google Group][] to discuss FlatBuffers with other developers and users.`
			`* [FlatBuffers Issues Tracker][] to submit an issue.`
			* [stackoverflow.com][] with [`flatbuffers` tag][] for any questions regarding FlatBuffers.

			`To contribute to this project, see [CONTRIBUTING][].`

			`## Licensing`
			`Flatbuffers is licensed under the Apache License, Version 2.0. See [LICENSE][] for the full license text.`

Revamping the FlatBuffers docs. 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 2015-12-04 04:30:54 +00:00			`<br>`

Fix link to CONTRIBUTING 2016-07-16 04:26:50 +00:00			`[CONTRIBUTING]: http://github.com/google/flatbuffers/blob/master/CONTRIBUTING.md`
Revamping the FlatBuffers docs. 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 2015-12-04 04:30:54 +00:00			[`flatbuffers` tag]: https://stackoverflow.com/questions/tagged/flatbuffers
Update google user group link Original link returns 404. 2016-03-08 23:57:12 +00:00			`[FlatBuffers Google Group]: https://groups.google.com/forum/#!forum/flatbuffers`
Revamping the FlatBuffers docs. 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 2015-12-04 04:30:54 +00:00			`[FlatBuffers Issues Tracker]: http://github.com/google/flatbuffers/issues`
Update StackOverflow links to have relevant queries. Change-Id: I59159fb7205e4802f041b749d502a8f305d4176c 2017-03-29 18:58:42 +00:00			`[stackoverflow.com]: http://stackoverflow.com/search?q=flatbuffers`
adds https to landing page link so it resolves (#4757) 2018-05-31 16:37:51 +00:00			`[landing page]: https://google.github.io/flatbuffers`
Update readme.md 2016-01-22 16:57:47 +00:00			`[LICENSE]: https://github.com/google/flatbuffers/blob/master/LICENSE.txt`