aboutsummaryrefslogtreecommitdiffhomepage
path: root/INSTALL.md
diff options
context:
space:
mode:
authorGravatar David Garcia Quintas <dgq@google.com>2016-03-04 10:12:42 -0800
committerGravatar David Garcia Quintas <dgq@google.com>2016-03-04 10:12:42 -0800
commite7aa84fe8f51c065fcd84421eef01a802c1013a9 (patch)
tree0010ac443c27fa17fea08d516565bc54671e2de5 /INSTALL.md
parent2a8c28037061b94c02eb05fb532e268709af88e5 (diff)
parentda0d46ed815724d0b665529ae3ad6a811aebc501 (diff)
Merge branch 'master' of github.com:grpc/grpc into limit_cores_includes
Diffstat (limited to 'INSTALL.md')
-rw-r--r--INSTALL.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/INSTALL.md b/INSTALL.md
new file mode 100644
index 0000000000..d9411db021
--- /dev/null
+++ b/INSTALL.md
@@ -0,0 +1,46 @@
+#If you are in a hurry
+
+For language-specific installation instructions for gRPC runtime, please
+refer to these documents
+
+ * [C++](examples/cpp)
+ * [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
+```
+
+#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
+```