From 5329e4bd3f7c5580b67a784c64a7aacbd5cb3549 Mon Sep 17 00:00:00 2001 From: Stanley Cheung <stanleycheung@google.com> Date: Wed, 19 Aug 2015 15:59:59 -0700 Subject: [PATCH] update installation instructions, review feedback --- INSTALL | 17 +++++++++-------- src/node/README.md | 4 ++-- src/php/README.md | 4 ++-- src/python/README.md | 14 +++++++------- src/ruby/README.md | 4 ++-- 5 files changed, 22 insertions(+), 21 deletions(-) diff --git a/INSTALL b/INSTALL index b4a53bbba1..d183fceb9a 100644 --- a/INSTALL +++ b/INSTALL @@ -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 ******************************* diff --git a/src/node/README.md b/src/node/README.md index 08ccedf7d8..a945295ff3 100644 --- a/src/node/README.md +++ b/src/node/README.md @@ -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/ diff --git a/src/php/README.md b/src/php/README.md index b40a0d4178..01c4db61ae 100644 --- a/src/php/README.md +++ b/src/php/README.md @@ -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/ diff --git a/src/python/README.md b/src/python/README.md index b3b2f303d4..a7afd581b2 100644 --- a/src/python/README.md +++ b/src/python/README.md @@ -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/ diff --git a/src/ruby/README.md b/src/ruby/README.md index 979fb1a70b..71404a2671 100644 --- a/src/ruby/README.md +++ b/src/ruby/README.md @@ -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/ -- GitLab