diff options
Diffstat (limited to 'libraries/flatbuffers/README')
| -rw-r--r-- | libraries/flatbuffers/README | 47 |
1 files changed, 24 insertions, 23 deletions
diff --git a/libraries/flatbuffers/README b/libraries/flatbuffers/README index df4703a18a7b..1f5f7537e442 100644 --- a/libraries/flatbuffers/README +++ b/libraries/flatbuffers/README @@ -1,26 +1,27 @@ -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 +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. -Features: - - Access to serialized data without parsing/unpacking - - Memory efficiency and speed. The only memory needed to - access your data is that of the buffer. - - Flexible. Optional fields provides forwards and backwards - compatibility. - - Tiny code footprint. Small amounts of generated code, and - just a single small header as the minimum dependency. - - Strongly typed. Errors happen at compile time. - - Convenient to use. Generated C++ code allows for terse - access & construction code. - - Cross platform code with no dependencies. +Why use FlatBuffers? + * Access to serialized data without parsing/unpacking + * Memory efficiency and speed + * Flexible + * Tiny code footprint + * Strongly typed + * Convenient to use + * Cross platform code with no dependencies -Protocol Buffers is indeed relatively similar to FlatBuffers, -with the primary difference being that FlatBuffers does not -need a parsing/unpacking step to a secondary representation -before you can access data, often coupled with per-object -memory allocation. The code is an order of magnitude bigger, -too. Protocol Buffers has neither optional text import/export -nor schema language features like unions. +Why not use Protocol Buffers, or .. ? +Protocol Buffers is indeed relatively similar to FlatBuffers, with the +primary difference being that FlatBuffers does not need a parsing/ +unpacking step to a secondary representation before you can access +data, often coupled with per-object memory allocation. The code is an +order of magnitude bigger, too. Protocol Buffers has no optional text +import/export. + +If you would like to build the HTML documentation, pass DOCS=yes to +the build script. + +If you would like to include the samples, pass SAMPLES=yes to the +build script. |