Skip to content
Snippets Groups Projects
readme.md 2.55 KiB
Newer Older
![logo](http://google.github.io/flatbuffers/fpl_logo_small.png) FlatBuffers
Mandar's avatar
Mandar committed
===========

[![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 an efficient cross platform serialization library for games and
other memory constrained apps. It allows you to directly access serialized data without
unpacking/parsing it first, while still having great forwards/backwards compatibility.
Mandar's avatar
Mandar committed

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

## Supported operating systems
* Android
* Windows
* MacOS X
* Linux
Mandar's avatar
Mandar committed
## Supported programming languages
* C++
* C#
Mandar's avatar
Mandar committed
* Go
* Java
* JavaScript
* PHP
* Python

*and many more in progress...*
Mandar's avatar
Mandar committed

## Contribution
Mandar's avatar
Mandar committed
* [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][].

## Integration
For applications on Google Play that integrate this tool, usage is tracked.
This tracking is done automatically using the embedded version string
Mandar's avatar
Mandar committed
(**`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.

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

Morton Fox's avatar
Morton Fox committed
   [CONTRIBUTING]: http://github.com/google/flatbuffers/blob/master/CONTRIBUTING.md
   [`flatbuffers` tag]: https://stackoverflow.com/questions/tagged/flatbuffers
artiom's avatar
artiom committed
   [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]: http://google.github.io/flatbuffers
Mandar's avatar
Mandar committed
   [LICENSE]: https://github.com/google/flatbuffers/blob/master/LICENSE.txt