Skip to content
Snippets Groups Projects
Commit 97ef5e42 authored by Jan Tattermusch's avatar Jan Tattermusch
Browse files

Merge pull request #679 from tbetbetbe/grpc_ruby_update_readme

Grpc ruby update readme
parents e8199605 79a0a521
No related branches found
No related tags found
No related merge requests found
...@@ -11,7 +11,7 @@ Alpha : Ready for early adopters ...@@ -11,7 +11,7 @@ Alpha : Ready for early adopters
INSTALLATION PREREQUISITES INSTALLATION PREREQUISITES
-------------------------- --------------------------
This requires Ruby 2.x, as the RPC API surface uses keyword args. This requires Ruby 2.1, as the RPC API surface uses keyword args.
QUICK - INSTALL QUICK - INSTALL
...@@ -19,6 +19,7 @@ QUICK - INSTALL ...@@ -19,6 +19,7 @@ QUICK - INSTALL
- Clone this repository. - Clone this repository.
- Follow the instructions in [INSTALL](../../INSTALL) to install the gRPC C core. - Follow the instructions in [INSTALL](../../INSTALL) to install the gRPC C core.
- If you don't have Ruby 2.1 installed, switch to the more detailed instructions below
- Use bundler to install - Use bundler to install
```sh ```sh
$ # from this directory $ # from this directory
...@@ -35,16 +36,18 @@ $ cd ../.. ...@@ -35,16 +36,18 @@ $ cd ../..
$ make && sudo make install $ make && sudo make install
``` ```
- Install Ruby 2.x. Consider doing this with [RVM](http://rvm.io), it's a nice way of controlling - Install Ruby 2.1. Consider doing this with [RVM](http://rvm.io), it's a nice way of controlling
the exact ruby version that's used. the exact ruby version that's used.
```sh ```sh
$ command curl -sSL https://rvm.io/mpapis.asc | gpg --import - $ command curl -sSL https://rvm.io/mpapis.asc | gpg --import -
$ \curl -sSL https://get.rvm.io | bash -s stable --ruby $ \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
- Install [bundler](http://bundler.io/) - Install [bundler](http://bundler.io/)
``` ```
$ gem install bundler $ gem install bundler
...@@ -52,9 +55,9 @@ $ gem install bundler ...@@ -52,9 +55,9 @@ $ gem install bundler
- Finally, install the gRPC gem locally. - Finally, install the gRPC gem locally.
```sh ```sh
$ cd <install_dir> $ # from this directory
$ bundle install $ bundle install # creates the ruby bundle, including building the grpc extension
$ rake # compiles the extension, runs the unit tests, see rake -T for other options $ rake # runs the unit tests, see rake -T for other options
``` ```
CONTENTS CONTENTS
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment