diff options
Diffstat (limited to 'tvix/castore-go/README.md')
-rw-r--r-- | tvix/castore-go/README.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/tvix/castore-go/README.md b/tvix/castore-go/README.md new file mode 100644 index 000000000000..c7a2205ae884 --- /dev/null +++ b/tvix/castore-go/README.md @@ -0,0 +1,10 @@ +# castore-go + +This directory contains generated golang bindings, both for the `tvix-castore` +data models, as well as the gRPC bindings. + +They are generated with `mg run //tvix:castore-go:regenerate`. +These files end with `.pb.go`, and are ensured to be up to date by a CI check. + +Additionally, code useful when interacting with these data structures +(ending just with `.go`) is provided. |