aboutsummaryrefslogtreecommitdiffhomepage
path: root/Firestore/Protos/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Firestore/Protos/README.md')
-rw-r--r--Firestore/Protos/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/Firestore/Protos/README.md b/Firestore/Protos/README.md
new file mode 100644
index 0000000..cb6d90e
--- /dev/null
+++ b/Firestore/Protos/README.md
@@ -0,0 +1,20 @@
+## Usage
+
+```
+cd firebase-ios-sdk/Firestore/Protos
+./build-protos.sh
+```
+
+Verify diffs, tests and make PR
+
+### Script Details
+
+Get the protoc and the gRPC plugin. See
+[here](https://github.com/grpc/grpc/tree/master/src/objective-c). The
+easiest way I found was to add
+`pod '!ProtoCompiler-gRPCPlugin'` to a Podfile and do `pod update`.
+
+After running the protoc, shell commands run to fix up the generated code:
+ * Flatten import paths for CocoaPods library build.
+ * Remove unneeded extensionRegistry functions.
+ * Remove non-buildable code from Annotations.pbobjc.*.