Skip to content

Commit cd3c59a

Browse files
committed
Merge pull request grpc#203 from LisaFC/overviewupdate
Updated installation instructions
2 parents 868b1d0 + 0ac906f commit cd3c59a

File tree

1 file changed

+14
-17
lines changed

1 file changed

+14
-17
lines changed

docs/index.md

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -342,13 +342,10 @@ To install protocol buffers support (the protocol buffer compiler and the protoc
342342
If you <a href="https://github.com/grpc/grpc/blob/{{ site.data.config.grpc_release_branch }}/INSTALL.md">build and install gRPC from source</a>, the Makefile will automatically install <code>protoc</code> as well (if you don't already have it installed). Installing gRPC also gets you the gRPC C++ plugin for <code>protoc</code>.
343343
</div>
344344
<div id="python_protoc">
345-
First <a href="https://github.com/google/protobuf/blob/master/README.md">install <code>protoc</code></a> from its Github repository. Then build and install the gRPC plugin:
345+
On Mac, Linux, and Windows, run:
346346

347347
<pre>
348-
git clone https://github.com/grpc/grpc.git $REPO
349-
cd $REPO
350-
make grpc_python_plugin
351-
cp bins/opt/grpc_python_plugin $SOMEWHERE_ON_PATH
348+
pip install grpcio-tools
352349
</pre>
353350
</div>
354351
<div id="go_protoc">
@@ -359,17 +356,17 @@ $ go get -a github.com/golang/protobuf/protoc-gen-go
359356
</pre>
360357
</div>
361358
<div id="ruby_protoc">
362-
First <a href="https://github.com/google/protobuf/blob/master/README.md">install <code>protoc</code></a> from its Github repository. Then build and install the gRPC plugin:
359+
On Mac, Linux, and Windows, run:
363360

364361
<pre>
365-
git clone https://github.com/grpc/grpc.git $REPO
366-
cd $REPO
367-
make grpc_ruby_plugin
368-
cp bins/opt/grpc_ruby_plugin $SOMEWHERE_ON_PATH
362+
gem install grpc-tools
369363
</pre>
370364
</div>
371365
<div id="node_protoc">
372-
The Node.js gRPC library currently dynamically generates the necessary gRPC code at runtime, so you don't need to install a protocol buffer compiler yourself.
366+
The Node.js gRPC library can either dynamically generate the necessary gRPC code at runtime or you can use the protocol buffer code generated by <code>protoc</code>. In our example we're going to use dynamic code generation, so if you want to follow along you don't need to have the protocol buffer compiler installed. If you do want to use statically generated code, you can install the compiler by running:
367+
<pre>
368+
npm install grpc-tools
369+
</pre>
373370
</div>
374371
<div id="csharp_protoc">
375372
Install the <a href="https://www.nuget.org/packages/Google.Protobuf">Google.Protobuf</a> and <a href="https://www.nuget.org/packages/Grpc.Tools">Grpc.Tools</a> NuGet packages from your IDE (Visual Studio, Xamarin Studio or Monodevelop).
@@ -378,7 +375,7 @@ Install the <a href="https://www.nuget.org/packages/Google.Protobuf">Google.Prot
378375
Follow the instructions in <a href="https://github.com/grpc/grpc/tree/master/src/objective-c">gRPC for Objective C</a> to install <code>protoc</code> and the appropriate plugin. Instructions are provided for installation with and without Homebrew.
379376
</div>
380377
<div id="php_protoc">
381-
First <a href="https://github.com/google/protobuf/blob/master/README.md">install <code>protoc</code></a> from its Github repository. Then install the third-party <code>protoc-gen-php</code> plugin.
378+
First <a href="https://github.com/google/protobuf/blob/master/README.md">install <code>protoc</code></a> from its Github repository. Then install the <a href="https://github.com/stanley-cheung/protobuf-php">third-party <code>protoc-gen-php</code> plugin</a>.
382379
</div>
383380
</div>
384381

@@ -765,7 +762,7 @@ message, as specified in our interface definition, then return.</p>
765762

766763
</div>
767764
<div id="node_service">
768-
<p><a href="https://github.com/grpc/grpc/blob/{{ site.data.config.grpc_release_branch }}/examples/node/greeter_server.js">greeter&lowbar;server.js</a> implements our <code>Greeter</code> service's required behaviour.
765+
<p><a href="https://github.com/grpc/grpc/blob/{{ site.data.config.grpc_release_branch }}/examples/node/dynamic_codegen/greeter_server.js">greeter&lowbar;server.js</a> implements our <code>Greeter</code> service's required behaviour.
769766
<p>Our server implements the <code>Greeter</code>service from our
770767
service definition by implementing the method <code>SayHello</code>:</p>
771768
<pre>
@@ -904,7 +901,7 @@ end
904901

905902
</div>
906903
<div id="node_server">
907-
<p><a href="https://github.com/grpc/grpc/blob/{{ site.data.config.grpc_release_branch }}/examples/node/greeter_server.js">greeter&lowbar;server.js</a> also provides this for our Node.js example.
904+
<p><a href="https://github.com/grpc/grpc/blob/{{ site.data.config.grpc_release_branch }}/examples/node/dynamic_codegen/greeter_server.js">greeter&lowbar;server.js</a> also provides this for our Node.js example.
908905
<pre>
909906
function main() {
910907
var server = new Server({
@@ -1147,7 +1144,7 @@ log.Printf("Greeting: %s", r.Message)</pre>
11471144
<pre> client.sayHello({name: user}, function(err, response) {
11481145
console.log('Greeting:', response.message);
11491146
});</pre>
1150-
<p>You can see the complete client code in <a href="https://github.com/grpc/grpc/blob/{{ site.data.config.grpc_release_branch }}/examples/node/greeter_client.js">greeter_client.js</a>.</p>
1147+
<p>You can see the complete client code in <a href="https://github.com/grpc/grpc/blob/{{ site.data.config.grpc_release_branch }}/examples/node/dynamic_codegen/greeter_client.js">greeter_client.js</a>.</p>
11511148

11521149
</div>
11531150
<div id="csharp_call">
@@ -1233,7 +1230,7 @@ Then run the server, which will listen on port 50051:
12331230

12341231
</div>
12351232
<div id="node_runserver">
1236-
<p>You can run the server from <code>examples/node</code> using:
1233+
<p>You can run the server from <code>examples/node/dynamic&#95;codegen</code> using:
12371234
<pre>$ node ./greeter_server.js &</pre>
12381235

12391236
</div>
@@ -1297,7 +1294,7 @@ Then run the client:
12971294

12981295
</div>
12991296
<div id="node_runclient">
1300-
<p>You can run the client from <code>examples/node</code> using:
1297+
<p>You can run the client from <code>examples/node/dynamic&#95;codegen</code> using:
13011298
<pre>$ node ./greeter_client.js</pre>
13021299

13031300
</div>

0 commit comments

Comments
 (0)