aboutsummaryrefslogtreecommitdiffhomepage
path: root/src
diff options
context:
space:
mode:
authorGravatar Yuchen Zeng <zyc@google.com>2016-03-09 12:00:09 -0800
committerGravatar Yuchen Zeng <zyc@google.com>2016-03-09 12:00:09 -0800
commit798b0dc4426f4485ad108a04c2dd44285ba2e700 (patch)
tree52bb39b3ce3d3440f7937802b8908a6966c0c2e0 /src
parent341b5abef5a039a731c9da260c4e9b76b1849415 (diff)
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
Diffstat (limited to 'src')
-rw-r--r--src/cpp/README.md35
1 files changed, 25 insertions, 10 deletions
diff --git a/src/cpp/README.md b/src/cpp/README.md
index a13669b99e..83d37aa2ed 100644
--- a/src/cpp/README.md
+++ b/src/cpp/README.md
@@ -30,10 +30,8 @@ terminal:
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.
+If you compile gRPC from source, as described below, this also installs the
+`protoc` compiler.
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
Alternatively, you can download `protoc` binaries from
[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
@@ -59,9 +58,25 @@ Currently to install gRPC for C++, you need to build from source as described be
$ [sudo] make install
```
-#DOCUMENTATION
+#Documentation
-- The gRPC C++ refenrence documentation is available online at
- [grpc.io](http://www.grpc.io/docs/tutorials/basic/c.html)
-- [Helloworld example](../../examples/cpp/helloworld)
+You can find out how to build and run our simplest gRPC C++ example in our
+[C++ quick start](https://github.com/grpc/grpc/tree/{{ site.data.config.grpc_release_branch }}/examples/cpp).
+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.