From 033cdd0993f91b9ee44043956ac0b7424cd754bc Mon Sep 17 00:00:00 2001 From: Eric Anderson Date: Thu, 10 Sep 2015 10:29:14 -0700 Subject: [PATCH] Discourage users from running the codegen for the example --- examples/README.md | 2 +- examples/javatutorial.md | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/examples/README.md b/examples/README.md index c2a4cf4126..3b14356f4c 100644 --- a/examples/README.md +++ b/examples/README.md @@ -4,7 +4,7 @@ grpc Examples To build the examples, run in this directory: ``` -$ ../gradlew installDist +$ ../gradlew installDist -PskipCodegen=true ``` This creates the scripts `hello-world-server`, `hello-world-client`, diff --git a/examples/javatutorial.md b/examples/javatutorial.md index 0d65f99d36..b96a899641 100644 --- a/examples/javatutorial.md +++ b/examples/javatutorial.md @@ -98,7 +98,9 @@ message Point { Next we need to generate the gRPC client and server interfaces from our .proto service definition. We do this using the protocol buffer compiler `protoc` with a special gRPC Java plugin. You need to use the [proto3](https://github.com/google/protobuf/releases) compiler in order to generate gRPC services -For simplicity, we've provided a [Gradle build file](https://github.com/grpc/grpc-java/blob/master/examples/build.gradle) that runs `protoc` for you with the appropriate plugin, input, and output (if you want to run this yourself, make sure you've installed protoc and followed the gRPC code [installation instructions](https://github.com/grpc/grpc-java) first): +For simplicity, we've built Maven and Gradle plugins that use pre-compiled protoc binaries. For using those in your project, see our [README.md](https://github.com/grpc/grpc-java/blob/master/README.md). The example is integrated into our grpc-java build to use unstable versions of the protoc plugin, so is much harder to run protoc than if you do it in your own project. + +For running the codegen in the example (not recommended), make sure you've installed protoc and followed the gRPC [compiling instructions](https://github.com/grpc/grpc-java/blob/master/COMPILING.md). You would then run: ```shell ../gradlew build