about summary refs log tree commit diff
path: root/tvix/build-go/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'tvix/build-go/README.md')
-rw-r--r--tvix/build-go/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/tvix/build-go/README.md b/tvix/build-go/README.md
new file mode 100644
index 000000000000..19edfced01a0
--- /dev/null
+++ b/tvix/build-go/README.md
@@ -0,0 +1,10 @@
+# build-go
+
+This directory contains generated golang bindings, both for the `tvix-build`
+data models, as well as the gRPC bindings.
+
+They are generated with `mg run //tvix/build-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.