Update C documentation with supported MSVC versions, and other minor updates.

parent 1db9783b
...@@ -10,22 +10,31 @@ JSON parsers, printers. ...@@ -10,22 +10,31 @@ JSON parsers, printers.
Great care has been taken to ensure compatibily with the main `flatc` Great care has been taken to ensure compatibily with the main `flatc`
project. project.
## General Documention ## General Documention
- [Tutorial](@ref flatbuffers_guide_tutorial) - select C as language - [Tutorial](@ref flatbuffers_guide_tutorial) - select C as language
when scrolling down when scrolling down
- General Use in C (README) <https://github.com/dvidelabs/flatcc/blob/master/README.md> - [FlatCC Guide](https://github.com/dvidelabs/flatcc#flatcc-flatbuffers-in-c-for-c)
- The C Builder Interface (advanced) <https://github.com/dvidelabs/flatcc/blob/master/doc/builder.md> - [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 ## Supported Platforms
- Ubuntu - Ubuntu (clang / gcc, ninja / gnu make)
- OS-X - OS-X (clang / gcc, ninja / gnu make)
- Windows - Windows MSVC 2010, 2013, 2015
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.
Centos has been tested at some point and ARM cross compilation has been reported to The monster sample project was specifically written for C99 in order to
work to some extend, but these are not regularly tested. follow the C++ version and for that reason it will not work with MSVC
2010.
## Modular Object Creation ## Modular Object Creation
......
...@@ -4,9 +4,9 @@ FlatBuffers {#flatbuffers_index} ...@@ -4,9 +4,9 @@ FlatBuffers {#flatbuffers_index}
# Overview {#flatbuffers_overview} # Overview {#flatbuffers_overview}
[FlatBuffers](@ref flatbuffers_overview) is an efficient cross platform [FlatBuffers](@ref flatbuffers_overview) is an efficient cross platform
serialization library for C++, C#, C, Go, Java, JavaScript, PHP, and Python 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 It was originally created at Google for game development and other
development and other performance-critical applications. performance-critical applications.
It is available as Open Source on [GitHub](http://github.com/google/flatbuffers) It is available as Open Source on [GitHub](http://github.com/google/flatbuffers)
under the Apache license, v2 (see LICENSE.txt). under the Apache license, v2 (see LICENSE.txt).
......
...@@ -18,23 +18,23 @@ In general: ...@@ -18,23 +18,23 @@ In general:
NOTE: this table is a start, it needs to be extended. NOTE: this table is a start, it needs to be extended.
Feature | C++ | Java | C# | Go | Python | JS | C | PHP | Ruby Feature | C++ | Java | C# | Go | Python | JS | C | PHP | Ruby
------------------------------ | ------ | ------ | ------ | ------ | ------ | --------- | ---- | --- | ---- ------------------------------ | ------ | ------ | ------ | ------ | ------ | --------- | ------ | --- | ----
Codegen for all basic features | Yes | Yes | Yes | Yes | Yes | Yes | Yes | WiP | WiP 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 JSON parsing | Yes | No | No | No | No | No | Yes | No | No
Simple mutation | Yes | WIP | WIP | No | No | No | No | No | No Simple mutation | Yes | WIP | WIP | No | No | No | No | No | No
Reflection | Yes | No | No | No | No | No | Basic| No | No Reflection | Yes | No | No | No | No | No | Basic | No | No
Buffer verifier | Yes | No | No | No | No | No | Yes | No | No Buffer verifier | Yes | No | No | No | No | No | Yes | No | No
Testing: basic | Yes | Yes | Yes | Yes | Yes | Yes | Yes | ? | ? Testing: basic | Yes | Yes | Yes | Yes | Yes | Yes | Yes | ? | ?
Testing: fuzz | Yes | No | No | Yes | Yes | No | No | ? | ? Testing: fuzz | Yes | No | No | Yes | Yes | No | No | ? | ?
Performance: | Superb | Great | Great | Great | Ok | ? |Superb| ? | ? Performance: | Superb | Great | Great | Great | Ok | ? | Superb | ? | ?
Platform: Windows | VS2010 | Yes | Yes | ? | ? | ? | Yes | ? | ? Platform: Windows | VS2010 | Yes | Yes | ? | ? | ? | VS2010 | ? | ?
Platform: Linux | GCC282 | Yes | ? | Yes | Yes | ? | Yes | ? | ? Platform: Linux | GCC282 | Yes | ? | Yes | Yes | ? | Yes | ? | ?
Platform: OS X | Xcode4 | ? | ? | ? | Yes | ? | Yes | ? | ? Platform: OS X | Xcode4 | ? | ? | ? | Yes | ? | Yes | ? | ?
Platform: Android | NDK10d | Yes | ? | ? | ? | ? | ? | ? | ? Platform: Android | NDK10d | Yes | ? | ? | ? | ? | ? | ? | ?
Platform: iOS | ? | ? | ? | ? | ? | ? | ? | ? | ? Platform: iOS | ? | ? | ? | ? | ? | ? | ? | ? | ?
Engine: Unity | ? | ? | Yes | ? | ? | ? | ? | ? | ? Engine: Unity | ? | ? | Yes | ? | ? | ? | ? | ? | ?
Primary authors (github) | gwvo | gwvo | ev*/js*| rw | rw | evanw/ev* | mik* | ch* | rw Primary authors (github) | gwvo | gwvo | ev*/js*| rw | rw | evanw/ev* | mik* | ch* | rw
* ev = evolutional * ev = evolutional
* js = jonsimantov * js = jonsimantov
......
...@@ -19,17 +19,16 @@ character, the hero of the story, needs to slay some `orc`s. We will walk ...@@ -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. through each step necessary to create this monster type using FlatBuffers.
Please select your desired language for our quest: Please select your desired language for our quest:
\htmlonly \htmlonly
<form> <form>
<input type="radio" name="language" value="cpp" checked="checked">C++</input> <input type="radio" name="language" value="cpp" checked="checked">C++</input>
<input type="radio" name="language" value="java">Java</input>
<input type="radio" name="language" value="csharp">C#</input> <input type="radio" name="language" value="csharp">C#</input>
<input type="radio" name="language" value="c">C</input>
<input type="radio" name="language" value="go">Go</input> <input type="radio" name="language" value="go">Go</input>
<input type="radio" name="language" value="java">Java</input> <input type="radio" name="language" value="python">Python</input>
<input type="radio" name="language" value="javascript">JavaScript</input> <input type="radio" name="language" value="javascript">JavaScript</input>
<input type="radio" name="language" value="php">PHP</input> <input type="radio" name="language" value="php">PHP</input>
<input type="radio" name="language" value="python">Python</input> <input type="radio" name="language" value="c">C</input>
</form> </form>
\endhtmlonly \endhtmlonly
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment