diff options
| author |  Yang Gao <yangg@google.com> | 2015-02-26 09:03:17 -0800 |
|---|---|---|
| committer | Yang Gao <yangg@google.com> | 2015-02-26 09:03:17 -0800 |
| commit | 6b27c3c1877ea9af5892c2ca1a2ab52270a48f07 (patch) | |
| tree | a51daf985420fe00dc2010d095fd7cc7600ce8f7 | |
| parent | a2da9169238d47fb21a47367a0c38b5fb54bb942 (diff) | |
| parent | 8af5175e1f8002a1aef08229658bb4b64b2e5a71 (diff) | |
Merge pull request #102 from tbetbetbe/ruby-docs-fix-clarify-helloworld-instructions
Ruby docs fix/clarify helloworld instructions
| -rw-r--r-- | ruby/README.md | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/ruby/README.md b/ruby/README.md index 8bdf4d93a2..57b0f45e63 100644 --- a/ruby/README.md +++ b/ruby/README.md @@ -9,24 +9,28 @@ PREREQUISITES ------------- This requires Ruby 2.1, as the gRPC API surface uses keyword args. - If you don't have that installed locally, you can use [RVM](https://www.rvm.io/) to use Ruby 2.1 for testing without upgrading the version of Ruby on your whole system. +RVM is also useful if you don't have the necessary privileges to update your system's Ruby. ```sh -$ command curl -sSL https://rvm.io/mpapis.asc | gpg --import - +$ # RVM installation as specified at https://rvm.io/rvm/install +$ gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 $ \curl -sSL https://get.rvm.io | bash -s stable --ruby=ruby-2.1 $ $ # follow the instructions to ensure that your're using the latest stable version of Ruby $ # and that the rvm command is installed ``` -- Make sure your run `source $HOME/.rvm/scripts/rvm` as instructed to complete the set up of RVM +- *N.B* Make sure your run `source $HOME/.rvm/scripts/rvm` as instructed to complete the set-up of RVM. INSTALL ------- - Clone this repository. - Follow the instructions in [INSTALL](https://github.com/grpc/grpc/blob/master/INSTALL) to install the gRPC C core. -- *Temporary* Install the full gRPC distribution from source on your local machine and update path: in [Gemfile](https://github.com/grpc/grpc-common/blob/master/ruby/Gemfile) to refer src/ruby within it. - - this is necessary until the gRPC ruby gem is published +- *Temporary* + - Install the full gRPC distribution from source on your local machine + - Build gRPC Ruby as described in [installing from source](https://github.com/grpc/grpc/blob/master/src/ruby/README.md#installing-from-source) + - update `path:` in [Gemfile](https://github.com/grpc/grpc-common/blob/master/ruby/Gemfile) to refer to src/ruby within the gRPC directory + - N.B: these steps are necessary until the gRPC ruby gem is published - Use bundler to install ```sh $ # from this directory |