Skip to content

Commit 364bd18

Browse files
committed
Add initial README with flatbuffers explanations
1 parent 2f267e1 commit 364bd18

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Library for Linear Reference System
2+
3+
TODO: explain what this library is for
4+
5+
## Using liblrs
6+
7+
### Data serialization with FlatBuffers
8+
9+
The data that defines an LRS is serialized using the [FlatBuffers format](https://flatbuffers.dev/).
10+
11+
The schema is described in [schema/lrs.fbs](schema/lrs.fbs). The library is written in rust and the [generated file](src/lrs_generated.rs) is commited. This means there is no need to have the `flatc` executable to build and run this project.
12+
13+
If your contribution changes the schema, you will need to generate the file with
14+
15+
`flatc -o src --rust schema/lrs.fbs`

0 commit comments

Comments
 (0)