Cleanup for release

This commit is contained in:
2026-03-28 23:10:58 -04:00
parent 40093c8534
commit 0056e7a9de
14 changed files with 293 additions and 0 deletions

26
README.md Normal file
View File

@@ -0,0 +1,26 @@
# Flatbuffers
We use [Google's Flatbuffers](https://flatbuffers.dev) for serialization. The main benefit of Flatbuffers over other serialization libraries is that Flatbuffers is small and fast (it does not require an unpacking step).
This repository contains all the Flatbuffer definition files (`.fbs`). It should only contain definition files.
Unless there is a good reason to add fields to the middle of a schema, please only add new fields to the end of schema files (to help maintain backward compatibility).
## Compiling
The schema definitions need to be compiled into code files for the languages we use.
The documentation for Flatbuffer's `flatc` tool can be found [here](https://flatbuffers.dev/flatc).
The generated files should then be copied into the respective repositories. Flatbuffers offers backward and forward compatibility.
### Installation
#### MacOS
Install `flatc` with homebrew
```
brew install flatbuffers
```
### Generating
```
flatc --cpp <filename>
```