aboutsummaryrefslogtreecommitdiff
path: root/test/flatc_compat/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'test/flatc_compat/README.md')
-rw-r--r--test/flatc_compat/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/test/flatc_compat/README.md b/test/flatc_compat/README.md
new file mode 100644
index 0000000..ffc0bf0
--- /dev/null
+++ b/test/flatc_compat/README.md
@@ -0,0 +1,10 @@
+Basic sanity check to verify that a `flatcc` generated reader can read
+binaries generated by Googles `flatc` compiler.
+
+`monsterdata_test.mon` is generated by Googles flatc compiler using the
+`monsterdata_test.golden` json as input and `monster_test.fbs` as schema.
+
+`monsterdata_test.json` was also copied for completeness - it apparently
+relates to undocumented hash attributed that converts json strings into
+hashes where the golden file has the correct target type with respect to
+the schema..