Skip to content

Readme fixes #415

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

Readme fixes #415

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c5c79c9
Update README.md
puneith Jul 13, 2016
e75aa8b
Update README.md
puneith Jul 13, 2016
ea04a79
Update README.md
puneith Jul 13, 2016
3623ad0
Update README.md
puneith Jul 13, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 20 additions & 3 deletions speech/api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,25 +38,42 @@ See the
[Cloud Platform Auth Guide](https://cloud.google.com/docs/authentication#developer_workflow)
for more information.

### Pre-requisites

Below is the list of pre-requisites you need to perform

* Install [gcloud][gcloud]
* Install [pip][pip]

### Install the dependencies

The sample uses the [PyAudio][pyaudio] library to stream audio from your computer's microphone. PyAudio depends on [PortAudio][portaudio], which may need to be compiled when you install PyAudio. If you run into compilation issues that mention PortAudio, you may have to [install some dependencies][pyaudio-install].
The sample uses the [PyAudio][pyaudio] library to stream audio from your computer's microphone. PyAudio depends on [PortAudio][portaudio], which may need to be compiled when you install PyAudio.

* If you run into compilation issues that mention PortAudio, you may have to [install some dependencies][pyaudio-install].

* If you run into compilation issues that mention PortAudio for Ubuntu

```
$ sudo apt-get install portaudio19-dev
```

* If you're running the `speech_rest.py` sample:

```sh
$ sudo pip install -r requirements-speech_rest.txt
$ sudo pip install -r requirements-speech_rest.txt --ignore-installed six
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't use sudo, don't ignore installed six, just tell them to use virtualenv.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have been thinking about that as well. virtual env or conda. But, the problem is what if they want to do something outside of virtual?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

virtual / conda makes life so much easier.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then that's up to them. Virtualenv isn't a controversial recommendation. It's broadly used, and recommended by every other sample here.

```

* If you're running the `speech_streaming.py` sample:

```sh
$ sudo pip install -r requirements-speech_grpc.txt
$ sudo pip install -r requirements-speech_grpc.txt --ignore-installed six
```

[pyaudio]: https://people.csail.mit.edu/hubert/pyaudio/
[portaudio]: http://www.portaudio.com/
[pyaudio-install]: https://people.csail.mit.edu/hubert/pyaudio/#downloads
[gcloud]: https://cloud.google.com/sdk/gcloud/
[pip]: https://pip.pypa.io/en/stable/installing/

## Run the example

Expand Down