Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / flatbuffers / refs/heads/int/13/fp4 / . / readme.md
blob: 7cccfa1dcb6574bb1a4d3d96e960ff12d6bdb3dc [file] [log] [blame] [view]
Wouter van Oortmerssenf6240652016-07-27 17:34:00 -0700[diff] [blame]1![logo](http://google.github.io/flatbuffers/fpl_logo_small.png) FlatBuffers
Mandar8b4c0b92016-01-22 22:27:47 +0530[diff] [blame]2===========
The Gitter Badgerc4377392016-11-02 16:05:31 -0500[diff] [blame]3
Haibo Huangb9f6b1a2020-03-16 15:41:29 -0700[diff] [blame]4[![Build Status](https://travis-ci.org/google/flatbuffers.svg?branch=master)](https://travis-ci.org/google/flatbuffers)
5[![Build status](https://ci.appveyor.com/api/projects/status/yg5idd2fnusv1n10?svg=true)](https://ci.appveyor.com/project/gwvo/flatbuffers)
The Gitter Badgerc4377392016-11-02 16:05:31 -0500[diff] [blame]6[![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)
Haibo Huangb9f6b1a2020-03-16 15:41:29 -0700[diff] [blame]7[![Discord Chat](https://img.shields.io/discord/656202785926152206.svg)](https:///discord.gg/6qgKs3R)
8[![Twitter Follow](https://img.shields.io/twitter/follow/wvo.svg?style=social)](https://twitter.com/wvo)
9
Wouter van Oortmerssenf6240652016-07-27 17:34:00 -0700[diff] [blame]10
Wouter van Oortmerssen873a60b2018-09-21 10:42:00 -0700[diff] [blame]11**FlatBuffers** is a cross platform serialization library architected for
12maximum 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 -0800[diff] [blame]13
Mandar8b4c0b92016-01-22 22:27:47 +0530[diff] [blame]14**Go to our [landing page][] to browse our documentation.**
Wouter van Oortmerssen26a30732014-01-27 16:52:49 -0800[diff] [blame]15
Mandar8b4c0b92016-01-22 22:27:47 +0530[diff] [blame]16## Supported operating systems
Mandar8b4c0b92016-01-22 22:27:47 +0530[diff] [blame]17* Windows
18* MacOS X
19* Linux
Wouter van Oortmerssen873a60b2018-09-21 10:42:00 -0700[diff] [blame]20* Android
21* And any others with a recent C++ compiler.
Wouter van Oortmerssenf6240652016-07-27 17:34:00 -0700[diff] [blame]22
Mandar8b4c0b92016-01-22 22:27:47 +0530[diff] [blame]23## Supported programming languages
24* C++
25* C#
Mikkel Fahnøe Jørgensen9b8c91c2016-03-26 09:22:56 +0100[diff] [blame]26* C
Wouter van Oortmerssen873a60b2018-09-21 10:42:00 -0700[diff] [blame]27* Dart
Mandar8b4c0b92016-01-22 22:27:47 +0530[diff] [blame]28* Go
29* Java
30* JavaScript
Wouter van Oortmerssen873a60b2018-09-21 10:42:00 -0700[diff] [blame]31* Lobster
32* Lua
Mandar8b4c0b92016-01-22 22:27:47 +0530[diff] [blame]33* PHP
34* Python
Robert919c9292018-09-03 23:38:41 -0700[diff] [blame]35* Rust
Wouter van Oortmerssen873a60b2018-09-21 10:42:00 -0700[diff] [blame]36* TypeScript
franchuti68823f75f52015-04-01 12:35:37 +0200[diff] [blame]37
Wouter van Oortmerssen873a60b2018-09-21 10:42:00 -0700[diff] [blame]38*and more in progress...*
franchuti68823f75f52015-04-01 12:35:37 +0200[diff] [blame]39
Wouter van Oortmerssenf6240652016-07-27 17:34:00 -0700[diff] [blame]40## Contribution
Mandar8b4c0b92016-01-22 22:27:47 +0530[diff] [blame]41* [FlatBuffers Google Group][] to discuss FlatBuffers with other developers and users.
42* [FlatBuffers Issues Tracker][] to submit an issue.
43* [stackoverflow.com][] with [`flatbuffers` tag][] for any questions regarding FlatBuffers.
franchuti68823f75f52015-04-01 12:35:37 +0200[diff] [blame]44
Mandar8b4c0b92016-01-22 22:27:47 +0530[diff] [blame]45*To contribute to this project,* see [CONTRIBUTING][].
Wouter van Oortmerssen26a30732014-01-27 16:52:49 -0800[diff] [blame]46
Mandar8b4c0b92016-01-22 22:27:47 +0530[diff] [blame]47## Licensing
48*Flatbuffers* is licensed under the Apache License, Version 2.0. See [LICENSE][] for the full license text.
49
Mark Klara69a31b82015-12-03 20:30:54 -0800[diff] [blame]50<br>
51
Morton Fox58924532016-07-16 00:26:50 -0400[diff] [blame]52 [CONTRIBUTING]: http://github.com/google/flatbuffers/blob/master/CONTRIBUTING.md
Mark Klara69a31b82015-12-03 20:30:54 -0800[diff] [blame]53 [`flatbuffers` tag]: https://stackoverflow.com/questions/tagged/flatbuffers
artiomb49a7d12016-03-08 23:57:12 +0000[diff] [blame]54 [FlatBuffers Google Group]: https://groups.google.com/forum/#!forum/flatbuffers
Mark Klara69a31b82015-12-03 20:30:54 -0800[diff] [blame]55 [FlatBuffers Issues Tracker]: http://github.com/google/flatbuffers/issues
Wouter van Oortmerssen86992472017-03-29 11:58:42 -0700[diff] [blame]56 [stackoverflow.com]: http://stackoverflow.com/search?q=flatbuffers
Steve Barman06d32292018-05-31 12:37:51 -0400[diff] [blame]57 [landing page]: https://google.github.io/flatbuffers
Mandar8b4c0b92016-01-22 22:27:47 +0530[diff] [blame]58 [LICENSE]: https://github.com/google/flatbuffers/blob/master/LICENSE.txt