update installation instructions, review feedback

pull/2990/head
Stanley Cheung 10 years ago
parent a79a896d4c
commit 5329e4bd3f
  1. 17
      INSTALL
  2. 4
      src/node/README.md
  3. 4
      src/php/README.md
  4. 14
      src/python/README.md
  5. 4
      src/ruby/README.md

@ -11,15 +11,16 @@ wiki pages:
On Linux (Debian):
Note: you will need to add the Debian 'unstable' distribution to your source
Note: you will need to add the Debian 'unstable' distribution to your sources
file first.
Add the following line to your `/etc/apt/sources.list` file:
deb http://ftp.us.debian.org/debian unstable main contrib non-free
deb http://ftp.us.debian.org/debian unstable main contrib non-free
Install the gRPC library
$ sudo apt-get install libgrpc-dev
Install the gRPC library:
$ [sudo] apt-get install libgrpc-dev
OR
@ -27,21 +28,21 @@ OR
$ cd grpc
$ git submodule update --init
$ make
$ sudo make install
$ [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:
$ apt-get install build-essential autoconf libtool
$ [sudo] apt-get install build-essential autoconf libtool
Building the python wrapper requires the following:
$ apt-get install python-all-dev python-virtualenv
$ [sudo] apt-get install python-all-dev python-virtualenv
If you want to install in a different directory than the default /usr/lib, you can
override it on the command line:
$ make install prefix=/opt
$ [sudo] make install prefix=/opt
*******************************

@ -11,7 +11,7 @@ Alpha : Ready for early adopters
**Linux (Debian):**
Add [debian unstable][] (sid) to your `sources.list` file. Example:
Add [Debian unstable][] to your `sources.list` file. Example:
```sh
echo "deb http://ftp.us.debian.org/debian unstable main contrib non-free" | \
@ -107,4 +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/
[Debian unstable]:https://www.debian.org/releases/sid/

@ -32,7 +32,7 @@ $ sudo php -d detect_unicode=0 go-pear.phar
**Linux (Debian):**
Add [debian unstable][] (sid) to your `sources.list` file. Example:
Add [Debian unstable][] to your `sources.list` file. Example:
```sh
echo "deb http://ftp.us.debian.org/debian unstable main contrib non-free" | \
@ -172,4 +172,4 @@ $ ./bin/run_gen_code_test.sh
[homebrew]:http://brew.sh
[gRPC install script]:https://raw.githubusercontent.com/grpc/homebrew-grpc/master/scripts/install
[Node]:https://github.com/grpc/grpc/tree/master/src/node/examples
[debian unstable]:https://www.debian.org/releases/sid/
[Debian unstable]:https://www.debian.org/releases/sid/

@ -16,7 +16,7 @@ INSTALLATION
**Linux (Debian):**
Add [debian unstable][] (sid) to your `sources.list` file. Example:
Add [Debian unstable][] to your `sources.list` file. Example:
```sh
echo "deb http://ftp.us.debian.org/debian unstable main contrib non-free" | \
@ -30,6 +30,11 @@ sudo apt-get update
sudo apt-get install libgrpc-dev
```
Install the gRPC Python module
```sh
sudo pip install grpcio
```
**Mac OS X**
Install [homebrew][]. Run the following command to install gRPC Python.
@ -45,11 +50,6 @@ Please read our online documentation for a [Quick Start][] and a [detailed examp
BUILDING FROM SOURCE
---------------------
- Clone this repository
- Build the gRPC core from the root of the
[gRPC Git repository](https://github.com/grpc/grpc)
```
$ make shared_c static_c
```
- Use build_python.sh to build the Python code and install it into a virtual environment
```
@ -81,4 +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/
[Debian unstable]:https://www.debian.org/releases/sid/

@ -19,7 +19,7 @@ INSTALLATION
**Linux (Debian):**
Add [debian unstable][] (sid) to your `sources.list` file. Example:
Add [Debian unstable][] to your `sources.list` file. Example:
```sh
echo "deb http://ftp.us.debian.org/debian unstable main contrib non-free" | \
@ -93,4 +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/
[Debian unstable]:https://www.debian.org/releases/sid/

Loading…
Cancel
Save