update installation instructions, review feedback

ciajoe · Aug 19, 2015 · a79a896 · a79a896
1 parent dbeb1cd
commit a79a896
Show file tree

Hide file tree

Showing 4 changed files with 77 additions and 17 deletions.
diff --git a/INSTALL b/INSTALL
@@ -9,21 +9,25 @@ wiki pages:
 * If you are in a hurry *
 *************************
 
- $ git clone https://github.com/grpc/grpc.git
- $ cd grpc
- $ git submodule update --init
- $ make 
- $ sudo make install
+On Linux (Debian):
+
+ Note: you will need to add the Debian 'unstable' distribution to your source
+ file first.
+
+ Add the following line to your `/etc/apt/sources.list` file:
 
-OR, on Linux (Debian):
+ deb http://ftp.us.debian.org/debian unstable main contrib non-free
 
+ Install the gRPC library
  $ sudo apt-get install libgrpc-dev
 
- Note: you will need to add the Debian 'unstable' distribution to your source
- file first. Example: Add the following line to your `/etc/apt/sources.list`
- file.
+OR
 
- deb http://ftp.us.debian.org/debian unstable main contrib non-free
+ $ git clone https://github.com/grpc/grpc.git
+ $ cd grpc
+ $ git submodule update --init
+ $ make 
+ $ sudo make install
 
 You don't need anything else than GNU Make, gcc and autotools. Under a Debian
 or Ubuntu system, this should boil down to the following packages:

diff --git a/src/node/README.md b/src/node/README.md
@@ -8,7 +8,26 @@ Alpha : Ready for early adopters
 - [homebrew][] on Mac OS X.  These simplify the installation of the gRPC C core.
 
 ## INSTALLATION
-On Mac OS X, install [homebrew][]. Run the following command to install gRPC Node.js.
+
+**Linux (Debian):**
+
+Add [debian unstable][] (sid) to your `sources.list` file. Example:
+
+```sh
+echo "deb http://ftp.us.debian.org/debian unstable main contrib non-free" | \
+sudo tee -a /etc/apt/sources.list
+```
+
+Install the gRPC debian package
+
+```sh
+sudo apt-get update
+sudo apt-get install libgrpc-dev
+```
+
+**Mac OS X**
+
+Install [homebrew][]. Run the following command to install gRPC Node.js.
 ```sh
 $ curl -fsSL https://goo.gl/getgrpc | bash -s nodejs
 ```
@@ -88,3 +107,4 @@ An object with factory methods for creating credential objects for servers.
 
 [homebrew]:http://brew.sh
 [gRPC install script]:https://raw.githubusercontent.com/grpc/homebrew-grpc/master/scripts/install
+[debian unstable]:https://www.debian.org/releases/sid/
diff --git a/src/python/README.md b/src/python/README.md
@@ -13,7 +13,26 @@ PREREQUISITES
 
 INSTALLATION
 -------------
-On Mac OS X, install [homebrew][]. Run the following command to install gRPC Python.
+
+**Linux (Debian):**
+
+Add [debian unstable][] (sid) to your `sources.list` file. Example:
+
+```sh
+echo "deb http://ftp.us.debian.org/debian unstable main contrib non-free" | \
+sudo tee -a /etc/apt/sources.list
+```
+
+Install the gRPC debian package
+
+```sh
+sudo apt-get update
+sudo apt-get install libgrpc-dev
+```
+
+**Mac OS X**
+
+Install [homebrew][]. Run the following command to install gRPC Python.
 ```sh
 $ curl -fsSL https://goo.gl/getgrpc | bash -s python
 ```
@@ -62,3 +81,4 @@ $ ../../tools/distrib/python/submit.py
 [gRPC install script]:https://raw.githubusercontent.com/grpc/homebrew-grpc/master/scripts/install
 [Quick Start]:http://www.grpc.io/docs/tutorials/basic/python.html
 [detailed example]:http://www.grpc.io/docs/installation/python.html
+[debian unstable]:https://www.debian.org/releases/sid/
diff --git a/src/ruby/README.md b/src/ruby/README.md
@@ -16,7 +16,26 @@ PREREQUISITES
 
 INSTALLATION
 ---------------
-On Mac OS X, install [homebrew][]. Run the following command to install gRPC Ruby.
+
+**Linux (Debian):**
+
+Add [debian unstable][] (sid) to your `sources.list` file. Example:
+
+```sh
+echo "deb http://ftp.us.debian.org/debian unstable main contrib non-free" | \
+sudo tee -a /etc/apt/sources.list
+```
+
+Install the gRPC debian package
+
+```sh
+sudo apt-get update
+sudo apt-get install libgrpc-dev
+```
+
+**Mac OS X**
+
+Install [homebrew][]. Run the following command to install gRPC Ruby.
 ```sh
 $ curl -fsSL https://goo.gl/getgrpc | bash -s ruby
 ```
@@ -25,10 +44,6 @@ This will download and run the [gRPC install script][], then install the latest
 BUILD FROM SOURCE
 ---------------------
 - Clone this repository
-- Install the gRPC core library. Please refer to the [INSTALL](https://github.com/grpc/grpc/blob/master/INSTALL) file for more instructions.
-```sh
-$ sudo apt-get install libgrpc-dev
-```
 
 - Install Ruby 2.x. Consider doing this with [RVM](http://rvm.io), it's a nice way of controlling
   the exact ruby version that's used.
@@ -78,3 +93,4 @@ Directory structure is the layout for [ruby extensions][]
 [ruby extensions]:http://guides.rubygems.org/gems-with-extensions/
 [rubydoc]: http://www.rubydoc.info/gems/grpc
 [grpc.io]: http://www.grpc.io/docs/installation/ruby.html
+[debian unstable]:https://www.debian.org/releases/sid/