Chiebot-Mirror
/
grpc
mirror of https://github.com/grpc/grpc.git
8
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #102 from tbetbetbe/ruby-docs-fix-clarify-helloworld-instructions

Browse Source 
Ruby docs fix/clarify helloworld instructions
pull/3109/head
Yang Gao 10 years ago
parent a2da916923 8af5175e1f
commit 6b27c3c187
1 changed files with 9 additions and 5 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 14
      ruby/README.md

14
ruby/README.md
Unescape View File

@ -9,24 +9,28 @@ PREREQUISITES
------------- -------------
This requires Ruby 2.1, as the gRPC API surface uses keyword args. 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. 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 ```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 $ \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 $ # follow the instructions to ensure that your're using the latest stable version of Ruby
$ # and that the rvm command is installed $ # 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 INSTALL
------- -------
- Clone this repository. - Clone this repository.
- Follow the instructions in [INSTALL](https://github.com/grpc/grpc/blob/master/INSTALL) to install the gRPC C core. - 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. - *Temporary*
- this is necessary until the gRPC ruby gem is published - 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 - Use bundler to install
```sh ```sh
$ # from this directory $ # from this directory

Write Preview
Loading…
Cancel
Save