Skip to content
Snippets Groups Projects
Commit 798b0dc4 authored by Yuchen Zeng's avatar Yuchen Zeng
Browse files

Doc Fixit: src/cpp/README need more information, revised 03092016

- Revised 'protoc' section and 'Documentation' section as LisaFC suggested.
- Added 'Examples' section as LisaFC suggested.

Resolves: #5661
parent 341b5abe
No related branches found
No related tags found
No related merge requests found
...@@ -30,10 +30,8 @@ terminal: ...@@ -30,10 +30,8 @@ terminal:
By default gRPC uses [protocol buffers](https://github.com/google/protobuf), By default gRPC uses [protocol buffers](https://github.com/google/protobuf),
you will need the `protoc` compiler to generate stub server and client code. 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 If you compile gRPC from source, as described below, this also installs the
automatically try and compile the `protoc` in third party if you cloned the `protoc` compiler.
repository recursively and it detects that you don't already have it
installed.
If it hasn't been installed, you can run the following commands to install it. If it hasn't been installed, you can run the following commands to install it.
...@@ -45,9 +43,10 @@ $ sudo make install # 'make' should have been run by core grpc ...@@ -45,9 +43,10 @@ $ sudo make install # 'make' should have been run by core grpc
Alternatively, you can download `protoc` binaries from Alternatively, you can download `protoc` binaries from
[the protocol buffers Github repository](https://github.com/google/protobuf/releases). [the protocol buffers Github repository](https://github.com/google/protobuf/releases).
#INSTALLATION #Installation
Currently to install gRPC for C++, you need to build from source as described below. Currently to install gRPC for C++, you need to build from source as described
below.
#Build from Source #Build from Source
...@@ -59,9 +58,25 @@ Currently to install gRPC for C++, you need to build from source as described be ...@@ -59,9 +58,25 @@ Currently to install gRPC for C++, you need to build from source as described be
$ [sudo] make install $ [sudo] make install
``` ```
#DOCUMENTATION #Documentation
- The gRPC C++ refenrence documentation is available online at You can find out how to build and run our simplest gRPC C++ example in our
[grpc.io](http://www.grpc.io/docs/tutorials/basic/c.html) [C++ quick start](https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_branch }}/examples/cpp).
- [Helloworld example](../../examples/cpp/helloworld)
For more detailed documentation on using gRPC in C++ , see our main
documentation site at [grpc.io](http://grpc.io), specifically:
* [Overview](http://www.grpc.io/docs/): An introduction to gRPC with a simple
Hello World example in all our supported languages, including C++.
* [gRPC Basics - C++](http://www.grpc.io/docs/tutorials/basic/c.html):
A tutorial that steps you through creating a simple gRPC C++ example
application.
* [Asynchronous Basics - C++](http://www.grpc.io/docs/tutorials/async/helloasync-cpp.html):
A tutorial that shows you how to use gRPC C++'s asynchronous/non-blocking
APIs.
# Examples
Code examples for gRPC C++ live in this repository's
[examples/cpp](https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_branch }}/examples/cpp) directory.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment