summaryrefslogtreecommitdiffstats
path: root/gen/README.mkd
diff options
context:
space:
mode:
Diffstat (limited to 'gen/README.mkd')
-rw-r--r--gen/README.mkd11
1 files changed, 11 insertions, 0 deletions
diff --git a/gen/README.mkd b/gen/README.mkd
new file mode 100644
index 00000000..e607772d
--- /dev/null
+++ b/gen/README.mkd
@@ -0,0 +1,11 @@
+Generated Files
+================
+
+This directory holds generated implementation files for the Protocol Buffer
+objects defined in openxc.proto. The definitions don't change very often, and so
+it makes more sense to keep a compiled version in the repository for each
+major build environment rather than requiring each developer to get the protobuf
+dependencies.
+
+I've also not found a good way to incorporate protobuf generation with our
+Makefile build system in the openxc/vi-firmware project.