Add note for common osx problem. (GoogleCloudPlatform#763)

engeshra · Jan 18, 2017 · bcc95af · bcc95af
1 parent 0398b40
commit bcc95af
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 12 deletions.
diff --git a/scripts/readme-gen/templates/install_portaudio.tmpl.rst b/scripts/readme-gen/templates/install_portaudio.tmpl.rst
@@ -5,16 +5,25 @@ Install `PortAudio`_. This is required by the `PyAudio`_ library to stream
 audio from your computer's microphone. PyAudio depends on PortAudio for cross-platform compatibility, and is installed differently depending on the
 platform.
 
-For Mac OS X, you can use `Homebrew`_::
+* For Mac OS X, you can use `Homebrew`_::
 
-    brew install portaudio
+      brew install portaudio
 
-For Debian / Ubuntu Linux::
+  **Note**: if you encounter an error when running `pip install` that indicates
+  it can't find `portaudio.h`, try running `pip install` with the following
+  flags::
 
-    apt-get install portaudio19-dev python-all-dev
+      pip install --global-option='build_ext' \
+          --global-option='-I/usr/local/include' \
+          --global-option='-L/usr/local/lib' \
+          pyaudio
 
-Windows may work without having to install PortAudio explicitly (it will get
-installed with PyAudio).
+* For Debian / Ubuntu Linux::
+
+      apt-get install portaudio19-dev python-all-dev
+
+* Windows may work without having to install PortAudio explicitly (it will get
+  installed with PyAudio).
 
 For more details, see the `PyAudio installation`_ page.
 

diff --git a/speech/grpc/README.rst b/speech/grpc/README.rst
@@ -53,16 +53,25 @@ Install `PortAudio`_. This is required by the `PyAudio`_ library to stream
 audio from your computer's microphone. PyAudio depends on PortAudio for cross-platform compatibility, and is installed differently depending on the
 platform.
 
-For Mac OS X, you can use `Homebrew`_::
+* For Mac OS X, you can use `Homebrew`_::
 
-    brew install portaudio
+      brew install portaudio
 
-For Debian / Ubuntu Linux::
+  **Note**: if you encounter an error when running `pip install` that indicates
+  it can't find `portaudio.h`, try running `pip install` with the following
+  flags::
 
-    apt-get install portaudio19-dev python-all-dev
+      pip install --global-option='build_ext' \
+          --global-option='-I/usr/local/include' \
+          --global-option='-L/usr/local/lib' \
+          pyaudio
 
-Windows may work without having to install PortAudio explicitly (it will get
-installed with PyAudio).
+* For Debian / Ubuntu Linux::
+
+      apt-get install portaudio19-dev python-all-dev
+
+* Windows may work without having to install PortAudio explicitly (it will get
+  installed with PyAudio).
 
 For more details, see the `PyAudio installation`_ page.