From bcf6cc51ca8c1c871ffe76512d30bd4c9f5f26ba Mon Sep 17 00:00:00 2001 From: Eric Anderson Date: Wed, 17 Aug 2016 14:12:41 -0700 Subject: [PATCH] Simplify commands in Android README Comments should really use '#', since it is shell. Also, we avoid telling users to clone the git repo since 1) this is basically implicit already and 2) it encourages them to checkout master instead of using the latest release. This is especially helpful when the document is referenced from http://grpc.io/docs since they specify checking out the latest release (which is much easier to maintain when using jekyll which is not an option here). --- examples/android/README.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/examples/android/README.md b/examples/android/README.md index fe0aa6cd19..e1eda55352 100644 --- a/examples/android/README.md +++ b/examples/android/README.md @@ -11,19 +11,16 @@ PREREQUISITES INSTALL ------- -**1. Clone the gRPC Java git repo** -```sh -$ git clone https://github.com/grpc/grpc-java -$ cd grpc-java -``` -**2. Install gRPC Java (not necessary for released versions)** +1. (Only for non-released versions) Install gRPC Java ```sh +$ cd ../.. $ ./gradlew install -PskipCodegen=true +$ cd examples/android ``` -**3. Install the app** +2. Install the app ```sh -$ cd examples/android/helloworld (or cd examples/android/routeguide) +$ cd helloworld # or "cd routeguide" $ ./gradlew installDebug ```