From 7d396bc2e75c25062e9084efb7f740e28fa86eb9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mikkel=20Fahn=C3=B8e=20J=C3=B8rgensen?= Date: Thu, 7 Apr 2016 18:52:00 +0200 Subject: [PATCH] Update C documentation with supported MSVC versions, and other minor updates. --- docs/source/CUsage.md | 25 +++++++++++++++++-------- docs/source/FlatBuffers.md | 6 +++--- docs/source/Support.md | 34 +++++++++++++++++----------------- docs/source/Tutorial.md | 9 ++++----- 4 files changed, 41 insertions(+), 33 deletions(-) diff --git a/docs/source/CUsage.md b/docs/source/CUsage.md index 6f293a81b..9aafa6f77 100644 --- a/docs/source/CUsage.md +++ b/docs/source/CUsage.md @@ -10,22 +10,31 @@ JSON parsers, printers. Great care has been taken to ensure compatibily with the main `flatc` project. - ## General Documention - [Tutorial](@ref flatbuffers_guide_tutorial) - select C as language when scrolling down -- General Use in C (README) -- The C Builder Interface (advanced) +- [FlatCC Guide](https://github.com/dvidelabs/flatcc#flatcc-flatbuffers-in-c-for-c) +- [The C Builder Interface](https://github.com/dvidelabs/flatcc/blob/master/doc/builder.md#the-builder-interface) +- [The Monster Sample in C](https://github.com/dvidelabs/flatcc/blob/master/samples/monster/monster.c) +- [GitHub](https://github.com/dvidelabs/flatcc) + ## Supported Platforms -- Ubuntu -- OS-X -- Windows +- Ubuntu (clang / gcc, ninja / gnu make) +- OS-X (clang / gcc, ninja / gnu make) +- Windows MSVC 2010, 2013, 2015 -Centos has been tested at some point and ARM cross compilation has been reported to -work to some extend, but these are not regularly tested. +CI builds recent versions of gcc, clang and MSVC on OS-X, Ubuntu, and +Windows, and occasionally older compiler versions. See main project [Status](https://github.com/dvidelabs/flatcc#status). + +Other platforms may well work, including Centos, but are not tested +regularly. + +The monster sample project was specifically written for C99 in order to +follow the C++ version and for that reason it will not work with MSVC +2010. ## Modular Object Creation diff --git a/docs/source/FlatBuffers.md b/docs/source/FlatBuffers.md index 7da09903b..46d4c1201 100644 --- a/docs/source/FlatBuffers.md +++ b/docs/source/FlatBuffers.md @@ -4,9 +4,9 @@ FlatBuffers {#flatbuffers_index} # Overview {#flatbuffers_overview} [FlatBuffers](@ref flatbuffers_overview) is an efficient cross platform -serialization library for C++, C#, C, Go, Java, JavaScript, PHP, and Python -(Ruby and Swift in progress). It was originally created at Google for game -development and other performance-critical applications. +serialization library for C++, C#, C, Go, Java, JavaScript, PHP, and Python. +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). diff --git a/docs/source/Support.md b/docs/source/Support.md index 7b01d1582..7bc33481d 100755 --- a/docs/source/Support.md +++ b/docs/source/Support.md @@ -18,23 +18,23 @@ In general: NOTE: this table is a start, it needs to be extended. -Feature | C++ | Java | C# | Go | Python | JS | C | PHP | Ruby ------------------------------- | ------ | ------ | ------ | ------ | ------ | --------- | ---- | --- | ---- -Codegen for all basic features | Yes | Yes | Yes | Yes | Yes | Yes | Yes | WiP | WiP -JSON parsing | Yes | No | No | No | No | No | Yes | No | No -Simple mutation | Yes | WIP | WIP | No | No | No | No | No | No -Reflection | Yes | No | No | No | No | No | Basic| No | No -Buffer verifier | Yes | No | No | No | No | No | Yes | No | No -Testing: basic | Yes | Yes | Yes | Yes | Yes | Yes | Yes | ? | ? -Testing: fuzz | Yes | No | No | Yes | Yes | No | No | ? | ? -Performance: | Superb | Great | Great | Great | Ok | ? |Superb| ? | ? -Platform: Windows | VS2010 | Yes | Yes | ? | ? | ? | Yes | ? | ? -Platform: Linux | GCC282 | Yes | ? | Yes | Yes | ? | Yes | ? | ? -Platform: OS X | Xcode4 | ? | ? | ? | Yes | ? | Yes | ? | ? -Platform: Android | NDK10d | Yes | ? | ? | ? | ? | ? | ? | ? -Platform: iOS | ? | ? | ? | ? | ? | ? | ? | ? | ? -Engine: Unity | ? | ? | Yes | ? | ? | ? | ? | ? | ? -Primary authors (github) | gwvo | gwvo | ev*/js*| rw | rw | evanw/ev* | mik* | ch* | rw +Feature | C++ | Java | C# | Go | Python | JS | C | PHP | Ruby +------------------------------ | ------ | ------ | ------ | ------ | ------ | --------- | ------ | --- | ---- +Codegen for all basic features | Yes | Yes | Yes | Yes | Yes | Yes | Yes | WiP | WiP +JSON parsing | Yes | No | No | No | No | No | Yes | No | No +Simple mutation | Yes | WIP | WIP | No | No | No | No | No | No +Reflection | Yes | No | No | No | No | No | Basic | No | No +Buffer verifier | Yes | No | No | No | No | No | Yes | No | No +Testing: basic | Yes | Yes | Yes | Yes | Yes | Yes | Yes | ? | ? +Testing: fuzz | Yes | No | No | Yes | Yes | No | No | ? | ? +Performance: | Superb | Great | Great | Great | Ok | ? | Superb | ? | ? +Platform: Windows | VS2010 | Yes | Yes | ? | ? | ? | VS2010 | ? | ? +Platform: Linux | GCC282 | Yes | ? | Yes | Yes | ? | Yes | ? | ? +Platform: OS X | Xcode4 | ? | ? | ? | Yes | ? | 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 diff --git a/docs/source/Tutorial.md b/docs/source/Tutorial.md index fdf7aca90..1e48796d9 100644 --- a/docs/source/Tutorial.md +++ b/docs/source/Tutorial.md @@ -19,17 +19,16 @@ character, the hero of the story, needs to slay some `orc`s. We will walk through each step necessary to create this monster type using FlatBuffers. Please select your desired language for our quest: - \htmlonly
C++ - C# - C - Go Java + C# + Go + Python JavaScript PHP - Python + C
\endhtmlonly