blob: 3d5467eb380b603f75a5fd279b7257a9a2a8bf6d [file] [log] [blame] [view]
Wouter van Oortmerssenf6240652016-07-27 17:34:00 -07001![logo](http://google.github.io/flatbuffers/fpl_logo_small.png) FlatBuffers
Mandar8b4c0b92016-01-22 22:27:47 +05302===========
The Gitter Badgerc4377392016-11-02 16:05:31 -05003
4[![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)
Wouter van Oortmerssenf6240652016-07-27 17:34:00 -07005[![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)
6
Wouter van Oortmerssen873a60b2018-09-21 10:42:00 -07007**FlatBuffers** is a cross platform serialization library architected for
8maximum memory efficiency. It allows you to directly access serialized data without parsing/unpacking it first, while still having great forwards/backwards compatibility.
Wouter van Oortmerssen26a30732014-01-27 16:52:49 -08009
Mandar8b4c0b92016-01-22 22:27:47 +053010**Go to our [landing page][] to browse our documentation.**
Wouter van Oortmerssen26a30732014-01-27 16:52:49 -080011
Mandar8b4c0b92016-01-22 22:27:47 +053012## Supported operating systems
Mandar8b4c0b92016-01-22 22:27:47 +053013* Windows
14* MacOS X
15* Linux
Wouter van Oortmerssen873a60b2018-09-21 10:42:00 -070016* Android
17* And any others with a recent C++ compiler.
Wouter van Oortmerssenf6240652016-07-27 17:34:00 -070018
Mandar8b4c0b92016-01-22 22:27:47 +053019## Supported programming languages
20* C++
21* C#
Mikkel Fahnøe Jørgensen9b8c91c2016-03-26 09:22:56 +010022* C
Wouter van Oortmerssen873a60b2018-09-21 10:42:00 -070023* Dart
Mandar8b4c0b92016-01-22 22:27:47 +053024* Go
25* Java
26* JavaScript
Wouter van Oortmerssen873a60b2018-09-21 10:42:00 -070027* Lobster
28* Lua
Mandar8b4c0b92016-01-22 22:27:47 +053029* PHP
30* Python
Robert919c9292018-09-03 23:38:41 -070031* Rust
Wouter van Oortmerssen873a60b2018-09-21 10:42:00 -070032* TypeScript
franchuti68823f75f52015-04-01 12:35:37 +020033
Wouter van Oortmerssen873a60b2018-09-21 10:42:00 -070034*and more in progress...*
franchuti68823f75f52015-04-01 12:35:37 +020035
Wouter van Oortmerssenf6240652016-07-27 17:34:00 -070036## Contribution
Mandar8b4c0b92016-01-22 22:27:47 +053037* [FlatBuffers Google Group][] to discuss FlatBuffers with other developers and users.
38* [FlatBuffers Issues Tracker][] to submit an issue.
39* [stackoverflow.com][] with [`flatbuffers` tag][] for any questions regarding FlatBuffers.
franchuti68823f75f52015-04-01 12:35:37 +020040
Mandar8b4c0b92016-01-22 22:27:47 +053041*To contribute to this project,* see [CONTRIBUTING][].
Wouter van Oortmerssen26a30732014-01-27 16:52:49 -080042
Mandar8b4c0b92016-01-22 22:27:47 +053043## Licensing
44*Flatbuffers* is licensed under the Apache License, Version 2.0. See [LICENSE][] for the full license text.
45
Mark Klara69a31b82015-12-03 20:30:54 -080046<br>
47
Morton Fox58924532016-07-16 00:26:50 -040048 [CONTRIBUTING]: http://github.com/google/flatbuffers/blob/master/CONTRIBUTING.md
Mark Klara69a31b82015-12-03 20:30:54 -080049 [`flatbuffers` tag]: https://stackoverflow.com/questions/tagged/flatbuffers
artiomb49a7d12016-03-08 23:57:12 +000050 [FlatBuffers Google Group]: https://groups.google.com/forum/#!forum/flatbuffers
Mark Klara69a31b82015-12-03 20:30:54 -080051 [FlatBuffers Issues Tracker]: http://github.com/google/flatbuffers/issues
Wouter van Oortmerssen86992472017-03-29 11:58:42 -070052 [stackoverflow.com]: http://stackoverflow.com/search?q=flatbuffers
Steve Barman06d32292018-05-31 12:37:51 -040053 [landing page]: https://google.github.io/flatbuffers
Mandar8b4c0b92016-01-22 22:27:47 +053054 [LICENSE]: https://github.com/google/flatbuffers/blob/master/LICENSE.txt