summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorWouter van Oortmerssen <wvo@google.com>2015-11-09 17:23:32 -0800
committerWouter van Oortmerssen <wvo@google.com>2015-11-09 17:25:17 -0800
commit9dc5d378b147a6c70799810f8db0754dd89ea12e (patch)
treecd1c107194cdbafcee747055873e8dd874a245c2 /docs
parentb0b39543decaa2df3bd6cf49b79b547b756e417a (diff)
downloadflatbuffers-9dc5d378b147a6c70799810f8db0754dd89ea12e.tar.gz
flatbuffers-9dc5d378b147a6c70799810f8db0754dd89ea12e.tar.bz2
flatbuffers-9dc5d378b147a6c70799810f8db0754dd89ea12e.zip
Updated supported languages in the docs.
Change-Id: I607f5f33b609c47fe32342f5e9d066f61f5546cd
Diffstat (limited to 'docs')
-rw-r--r--docs/html/index.html12
-rw-r--r--docs/html/md__support.html36
-rw-r--r--docs/source/FlatBuffers.md19
-rwxr-xr-xdocs/source/Support.md36
4 files changed, 58 insertions, 45 deletions
diff --git a/docs/html/index.html b/docs/html/index.html
index a59c95b7..f5d83531 100644
--- a/docs/html/index.html
+++ b/docs/html/index.html
@@ -61,19 +61,19 @@ $(document).ready(function(){initNavTree('index.html','');});
<div class="title">FlatBuffers Documentation</div> </div>
</div><!--header-->
<div class="contents">
-<div class="textblock"><p>FlatBuffers is an efficient cross platform serialization library for C++, with support for Java, C# and Go. It was created at Google specifically for game development and other performance-critical applications.</p>
+<div class="textblock"><p>FlatBuffers is an efficient cross platform serialization library for C++, Java, C#, Go, Python and JavaScript (C, PHP &amp; Ruby in progress). It was originally created at Google for game development and other performance-critical applications.</p>
<p>It is available as Open Source on <a href="http://github.com/google/flatbuffers">GitHub</a> under the Apache license, v2 (see LICENSE.txt).</p>
<h2>Why use FlatBuffers?</h2>
<ul>
<li><b>Access to serialized data without parsing/unpacking</b> - What sets FlatBuffers apart is that it represents hierarchical data in a flat binary buffer in such a way that it can still be accessed directly without parsing/unpacking, while also still supporting data structure evolution (forwards/backwards compatibility).</li>
-<li><b>Memory efficiency and speed</b> - The only memory needed to access your data is that of the buffer. It requires 0 additional allocations. FlatBuffers is also very suitable for use with mmap (or streaming), requiring only part of the buffer to be in memory. Access is close to the speed of raw struct access with only one extra indirection (a kind of vtable) to allow for format evolution and optional fields. It is aimed at projects where spending time and space (many memory allocations) to be able to access or construct serialized data is undesirable, such as in games or any other performance sensitive applications. See the <a href="md__benchmarks.html">benchmarks</a> for details.</li>
+<li><b>Memory efficiency and speed</b> - The only memory needed to access your data is that of the buffer. It requires 0 additional allocations (in C++, other languages may vary). FlatBuffers is also very suitable for use with mmap (or streaming), requiring only part of the buffer to be in memory. Access is close to the speed of raw struct access with only one extra indirection (a kind of vtable) to allow for format evolution and optional fields. It is aimed at projects where spending time and space (many memory allocations) to be able to access or construct serialized data is undesirable, such as in games or any other performance sensitive applications. See the <a href="md__benchmarks.html">benchmarks</a> for details.</li>
<li><b>Flexible</b> - Optional fields means not only do you get great forwards and backwards compatibility (increasingly important for long-lived games: don't have to update all data with each new version!). It also means you have a lot of choice in what data you write and what data you don't, and how you design data structures.</li>
<li><b>Tiny code footprint</b> - Small amounts of generated code, and just a single small header as the minimum dependency, which is very easy to integrate. Again, see the benchmark section for details.</li>
<li><b>Strongly typed</b> - Errors happen at compile time rather than manually having to write repetitive and error prone run-time checks. Useful code can be generated for you.</li>
<li><p class="startli"><b>Convenient to use</b> - Generated C++ code allows for terse access &amp; construction code. Then there's optional functionality for parsing schemas and JSON-like text representations at runtime efficiently if needed (faster and more memory efficient than other JSON parsers).</p>
-<p class="startli">Java and Go code supports object-reuse.</p>
+<p class="startli">Java and Go code supports object-reuse. C# has efficient struct based accessors.</p>
</li>
-<li><b>Cross platform C++11/Java/C#/Go code with no dependencies</b> - will work with any recent gcc/clang and VS2010. Comes with build files for the tests &amp; samples (Android .mk files, and cmake for all other platforms).</li>
+<li><b>Cross platform code with no dependencies</b> - C++ code will work with any recent gcc/clang and VS2010. Comes with build files for the tests &amp; samples (Android .mk files, and cmake for all other platforms).</li>
</ul>
<h3>Why not use Protocol Buffers, or .. ?</h3>
<p>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.</p>
@@ -115,6 +115,10 @@ $(document).ready(function(){initNavTree('index.html','');});
<li><a href="http://google.github.io/flatbuffers">Landing page</a></li>
<li><a href="http://group.google.com/group/flatbuffers">FlatBuffers Google Group</a></li>
<li><a href="http://github.com/google/flatbuffers/issues">FlatBuffers Issues Tracker</a></li>
+<li>Independent implementations &amp; tools:<ul>
+<li><a href="https://github.com/dvidelabs/flatcc">FlatCC</a> Alternative FlatBuffers parser, code generator and runtime all in C.</li>
+</ul>
+</li>
<li>Videos:<ul>
<li>Colt's <a href="https://www.youtube.com/watch?v=iQTxMkSJ1dQ">DevByte</a>.</li>
<li>GDC 2015 <a href="https://www.youtube.com/watch?v=olmL1fUnQAQ">Lightning Talk</a>.</li>
diff --git a/docs/html/md__support.html b/docs/html/md__support.html
index 5ac173fd..833f0331 100644
--- a/docs/html/md__support.html
+++ b/docs/html/md__support.html
@@ -71,41 +71,43 @@ $(document).ready(function(){initNavTree('md__support.html','');});
<p>NOTE: this table is a start, it needs to be extended.</p>
<table class="doxtable">
<tr>
-<th>Feature </th><th>C++ </th><th>Java </th><th>C# </th><th>Go </th><th>Python </th><th>JS </th></tr>
+<th>Feature </th><th>C++ </th><th>Java </th><th>C# </th><th>Go </th><th>Python </th><th>JS </th><th>C </th><th>PHP </th><th>Ruby </th></tr>
<tr>
-<td>Codegen for all basic features </td><td>Yes </td><td>Yes </td><td>Yes </td><td>Yes </td><td>Yes </td><td>WIP </td></tr>
+<td>Codegen for all basic features </td><td>Yes </td><td>Yes </td><td>Yes </td><td>Yes </td><td>Yes </td><td>Yes </td><td>WiP </td><td>WiP </td><td>WiP </td></tr>
<tr>
-<td>JSON parsing </td><td>Yes </td><td>No </td><td>No </td><td>No </td><td>No </td><td>No </td></tr>
+<td>JSON parsing </td><td>Yes </td><td>No </td><td>No </td><td>No </td><td>No </td><td>No </td><td>No </td><td>No </td><td>No </td></tr>
<tr>
-<td>Simple mutation </td><td>Yes </td><td>WIP </td><td>WIP </td><td>No </td><td>No </td><td>No </td></tr>
+<td>Simple mutation </td><td>Yes </td><td>WIP </td><td>WIP </td><td>No </td><td>No </td><td>No </td><td>No </td><td>No </td><td>No </td></tr>
<tr>
-<td>Reflection </td><td>Yes </td><td>No </td><td>No </td><td>No </td><td>No </td><td>No </td></tr>
+<td>Reflection </td><td>Yes </td><td>No </td><td>No </td><td>No </td><td>No </td><td>No </td><td>No </td><td>No </td><td>No </td></tr>
<tr>
-<td>Buffer verifier </td><td>Yes </td><td>No </td><td>No </td><td>No </td><td>No </td><td>No </td></tr>
+<td>Buffer verifier </td><td>Yes </td><td>No </td><td>No </td><td>No </td><td>No </td><td>No </td><td>No </td><td>No </td><td>No </td></tr>
<tr>
-<td>Testing: basic </td><td>Yes </td><td>Yes </td><td>Yes </td><td>Yes </td><td>Yes </td><td>WIP </td></tr>
+<td>Testing: basic </td><td>Yes </td><td>Yes </td><td>Yes </td><td>Yes </td><td>Yes </td><td>Yes </td><td>? </td><td>? </td><td>? </td></tr>
<tr>
-<td>Testing: fuzz </td><td>Yes </td><td>No </td><td>No </td><td>Yes </td><td>Yes </td><td>No </td></tr>
+<td>Testing: fuzz </td><td>Yes </td><td>No </td><td>No </td><td>Yes </td><td>Yes </td><td>No </td><td>? </td><td>? </td><td>? </td></tr>
<tr>
-<td>Performance: </td><td>Superb </td><td>Great </td><td>Great </td><td>Great </td><td>Ok </td><td>? </td></tr>
+<td>Performance: </td><td>Superb </td><td>Great </td><td>Great </td><td>Great </td><td>Ok </td><td>? </td><td>Superb</td><td>? </td><td>? </td></tr>
<tr>
-<td>Platform: Windows </td><td>VS2010 </td><td>Yes </td><td>Yes </td><td>? </td><td>? </td><td>? </td></tr>
+<td>Platform: Windows </td><td>VS2010 </td><td>Yes </td><td>Yes </td><td>? </td><td>? </td><td>? </td><td>? </td><td>? </td><td>? </td></tr>
<tr>
-<td>Platform: Linux </td><td>GCC282 </td><td>Yes </td><td>? </td><td>Yes </td><td>Yes </td><td>? </td></tr>
+<td>Platform: Linux </td><td>GCC282 </td><td>Yes </td><td>? </td><td>Yes </td><td>Yes </td><td>? </td><td>? </td><td>? </td><td>? </td></tr>
<tr>
-<td>Platform: OS X </td><td>Xcode4 </td><td>? </td><td>? </td><td>? </td><td>Yes </td><td>? </td></tr>
+<td>Platform: OS X </td><td>Xcode4 </td><td>? </td><td>? </td><td>? </td><td>Yes </td><td>? </td><td>? </td><td>? </td><td>? </td></tr>
<tr>
-<td>Platform: Android </td><td>NDK10d </td><td>Yes </td><td>? </td><td>? </td><td>? </td><td>? </td></tr>
+<td>Platform: Android </td><td>NDK10d </td><td>Yes </td><td>? </td><td>? </td><td>? </td><td>? </td><td>? </td><td>? </td><td>? </td></tr>
<tr>
-<td>Platform: iOS </td><td>? </td><td>? </td><td>? </td><td>? </td><td>? </td><td>? </td></tr>
+<td>Platform: iOS </td><td>? </td><td>? </td><td>? </td><td>? </td><td>? </td><td>? </td><td>? </td><td>? </td><td>? </td></tr>
<tr>
-<td>Engine: Unity </td><td>? </td><td>? </td><td>Yes </td><td>? </td><td>? </td><td>? </td></tr>
+<td>Engine: Unity </td><td>? </td><td>? </td><td>Yes </td><td>? </td><td>? </td><td>? </td><td>? </td><td>? </td><td>? </td></tr>
<tr>
-<td>Primary authors (github) </td><td>wvo </td><td>wvo </td><td>(ev/js)</td><td>rw </td><td>rw </td><td>(ev) </td></tr>
+<td>Primary authors (github) </td><td>gwvo </td><td>gwvo </td><td>ev*/js*</td><td>rw </td><td>rw </td><td>evanw/ev* </td><td>mik* </td><td>ch* </td><td>rw </td></tr>
</table>
<ul>
<li>ev = evolutional</li>
-<li>js = jonsimantov </li>
+<li>js = jonsimantov</li>
+<li>mik = mikkelfj</li>
+<li>ch = chobie </li>
</ul>
</div></div><!-- contents -->
</div><!-- doc-content -->
diff --git a/docs/source/FlatBuffers.md b/docs/source/FlatBuffers.md
index 3f5258f3..79846d77 100644
--- a/docs/source/FlatBuffers.md
+++ b/docs/source/FlatBuffers.md
@@ -1,8 +1,9 @@
# FlatBuffers
-FlatBuffers is an efficient cross platform serialization library for C++,
-with support for Java, C# and Go. It was created at Google specifically for game
-development and other performance-critical applications.
+FlatBuffers is an efficient cross platform serialization library for C++, Java,
+C#, Go, Python and JavaScript (C, PHP & Ruby in progress).
+It was originally created at Google for game development and other
+performance-critical applications.
It is available as Open Source on [GitHub](http://github.com/google/flatbuffers)
under the Apache license, v2 (see LICENSE.txt).
@@ -16,8 +17,8 @@ under the Apache license, v2 (see LICENSE.txt).
structure evolution (forwards/backwards compatibility).
- **Memory efficiency and speed** - The only memory needed to access
- your data is that of the buffer. It requires 0 additional allocations.
- FlatBuffers is also very
+ your data is that of the buffer. It requires 0 additional allocations
+ (in C++, other languages may vary). FlatBuffers is also very
suitable for use with mmap (or streaming), requiring only part of the
buffer to be in memory. Access is close to the speed of raw
struct access with only one extra indirection (a kind of vtable) to
@@ -47,9 +48,10 @@ under the Apache license, v2 (see LICENSE.txt).
needed (faster and more memory efficient than other JSON
parsers).
- Java and Go code supports object-reuse.
+ Java and Go code supports object-reuse. C# has efficient struct based
+ accessors.
-- **Cross platform C++11/Java/C#/Go code with no dependencies** - will work
+- **Cross platform code with no dependencies** - C++ code will work
with any recent gcc/clang and VS2010. Comes with build files for the tests &
samples (Android .mk files, and cmake for all other platforms).
@@ -139,6 +141,9 @@ sections provide a more in-depth usage guide.
- [Landing page](http://google.github.io/flatbuffers)
- [FlatBuffers Google Group](http://group.google.com/group/flatbuffers)
- [FlatBuffers Issues Tracker](http://github.com/google/flatbuffers/issues)
+- Independent implementations & tools:
+ - [FlatCC](https://github.com/dvidelabs/flatcc) Alternative FlatBuffers
+ parser, code generator and runtime all in C.
- Videos:
- Colt's [DevByte](https://www.youtube.com/watch?v=iQTxMkSJ1dQ).
- GDC 2015 [Lightning Talk](https://www.youtube.com/watch?v=olmL1fUnQAQ).
diff --git a/docs/source/Support.md b/docs/source/Support.md
index 6271bfef..7df42499 100755
--- a/docs/source/Support.md
+++ b/docs/source/Support.md
@@ -17,23 +17,25 @@ In general:
NOTE: this table is a start, it needs to be extended.
-Feature | C++ | Java | C# | Go | Python | JS
------------------------------- | ------ | ------ | ------ | ------ | ------ | ------
-Codegen for all basic features | Yes | Yes | Yes | Yes | Yes | WIP
-JSON parsing | Yes | No | No | No | No | No
-Simple mutation | Yes | WIP | WIP | No | No | No
-Reflection | Yes | No | No | No | No | No
-Buffer verifier | Yes | No | No | No | No | No
-Testing: basic | Yes | Yes | Yes | Yes | Yes | WIP
-Testing: fuzz | Yes | No | No | Yes | Yes | No
-Performance: | Superb | Great | Great | Great | Ok | ?
-Platform: Windows | VS2010 | Yes | Yes | ? | ? | ?
-Platform: Linux | GCC282 | Yes | ? | Yes | Yes | ?
-Platform: OS X | Xcode4 | ? | ? | ? | Yes | ?
-Platform: Android | NDK10d | Yes | ? | ? | ? | ?
-Platform: iOS | ? | ? | ? | ? | ? | ?
-Engine: Unity | ? | ? | Yes | ? | ? | ?
-Primary authors (github) | wvo | wvo | (ev/js)| rw | rw | (ev)
+Feature | C++ | Java | C# | Go | Python | JS | C | PHP | Ruby
+------------------------------ | ------ | ------ | ------ | ------ | ------ | --------- | ---- | --- | ----
+Codegen for all basic features | Yes | Yes | Yes | Yes | Yes | Yes | WiP | WiP | WiP
+JSON parsing | Yes | No | No | No | No | No | No | No | No
+Simple mutation | Yes | WIP | WIP | No | No | No | No | No | No
+Reflection | Yes | No | No | No | No | No | No | No | No
+Buffer verifier | Yes | No | No | No | No | No | No | No | No
+Testing: basic | Yes | Yes | Yes | Yes | Yes | Yes | ? | ? | ?
+Testing: fuzz | Yes | No | No | Yes | Yes | No | ? | ? | ?
+Performance: | Superb | Great | Great | Great | Ok | ? |Superb| ? | ?
+Platform: Windows | VS2010 | Yes | Yes | ? | ? | ? | ? | ? | ?
+Platform: Linux | GCC282 | Yes | ? | Yes | Yes | ? | ? | ? | ?
+Platform: OS X | Xcode4 | ? | ? | ? | Yes | ? | ? | ? | ?
+Platform: Android | NDK10d | Yes | ? | ? | ? | ? | ? | ? | ?
+Platform: iOS | ? | ? | ? | ? | ? | ? | ? | ? | ?
+Engine: Unity | ? | ? | Yes | ? | ? | ? | ? | ? | ?
+Primary authors (github) | gwvo | gwvo | ev*/js*| rw | rw | evanw/ev* | mik* | ch* | rw
* ev = evolutional
* js = jonsimantov
+ * mik = mikkelfj
+ * ch = chobie