Index: third_party/grpc/INSTALL.md |
diff --git a/third_party/grpc/INSTALL.md b/third_party/grpc/INSTALL.md |
new file mode 100644 |
index 0000000000000000000000000000000000000000..454a8b7b2fdf68590fe77e15a9b3d1c6ea7ccc08 |
--- /dev/null |
+++ b/third_party/grpc/INSTALL.md |
@@ -0,0 +1,57 @@ |
+#If you are in a hurry |
+ |
+For language-specific installation instructions for gRPC runtime, please |
+refer to these documents |
+ |
+ * [C++](examples/cpp): Currently to install gRPC for C++, you need to build from source as described below. |
+ * [C#](src/csharp): NuGet package `Grpc` |
+ * [Go](https://github.com/grpc/grpc-go): `go get google.golang.org/grpc` |
+ * [Java](https://github.com/grpc/grpc-java) |
+ * [Node](src/node): `npm install grpc` |
+ * [Objective-C](src/objective-c) |
+ * [PHP](src/php): `pecl install grpc-beta` |
+ * [Python](src/python/grpcio): `pip install grpcio` |
+ * [Ruby](src/ruby): `gem install grpc` |
+ |
+ |
+#Pre-requisites |
+ |
+##Linux |
+ |
+```sh |
+ $ [sudo] apt-get install build-essential autoconf libtool |
+``` |
+ |
+##Mac OSX |
+ |
+For a Mac system, git is not available by default. You will first need to |
+install Xcode from the Mac AppStore and then run the following command from a |
+terminal: |
+ |
+```sh |
+ $ [sudo] xcode-select --install |
+``` |
+ |
+##Protoc |
+ |
+By default gRPC uses [protocol buffers](https://github.com/google/protobuf), |
+you will need the `protoc` compiler to generate stub server and client code. |
+ |
+If you compile gRPC from source, as described below, the Makefile will |
+automatically try and compile the `protoc` in third_party if you cloned the |
+repository recursively and it detects that you don't already have it |
+installed. |
+ |
+ |
+#Build from Source |
+ |
+For developers who are interested to contribute, here is how to compile the |
+gRPC C Core library. |
+ |
+```sh |
+ $ git clone https://github.com/grpc/grpc.git |
+ $ cd grpc |
+ $ git submodule update --init |
+ $ make |
+ $ [sudo] make install |
+``` |