Index: third_party/cq_client/README.md |
diff --git a/third_party/cq_client/README.md b/third_party/cq_client/README.md |
new file mode 100644 |
index 0000000000000000000000000000000000000000..0822d116875788f0ca3060ba2ae37d801281e63f |
--- /dev/null |
+++ b/third_party/cq_client/README.md |
@@ -0,0 +1,13 @@ |
+This directory contains CQ client library to be distributed to other repos. If |
+you need to modify some files in this directory, please make sure that you are |
+changing the original version in the source code and not to one of the copies, |
Adrian Kuegel
2015/06/22 13:04:59
I think this should be: "that you are changing the
Sergiy Byelozyorov
2015/06/22 17:02:36
Done.
|
+which should only be updated as a whole using Glyco (when available). |
+ |
+To generate `cq_pb2.py`, please use protoc version 2.6.1: |
+ |
+ cd commit_queue/cq_client |
+ protoc cq.proto --python_out $(pwd) |
+ |
+Additionally, please make sure to use proto3-compatible syntax, e.g. no default |
+values, no required fields. Ideally, we should use proto3 generator already, |
+however alpha version thereof is still unstable. |