Changed git clone to git clone to git clone --depth=1 to reduce the cloning size as this is only for deployment of mycroft and not for development and added additional instructions for developers to use the whole repo instead of single depth repo.
As noted on the Chromium Dev How-to [1] and on the
SpeechRecognition library docs [2], the Google TTS API
is really not the right API to call. While it's simple,
and allows you to authenticate via a simple token, it is
also limited to a max of *50* requests per day.
That's not a lot. I don't think many people will find that
useful, outside of quick testing (if they can even get an
API key - I couldn't figure out how to generate one that
worked correctly).
This commit introduces a new STT backend, google_cloud, so that
the Google STT backend can be deprecated eventually. To do so, we
needed to:
- Install the Google API Client Library
- Create a new STT class which knows how to turn a provided Google
JSON credentials file into a string (the SpeechRecognition library
expects you to pass in the JSON string, not a file path, nor an object).
Any person wishing to use this will need to:
- Enable the Cloud Speech API on the Google Cloud Platform console
- Create a new Service Account Key, and download the credentials to
a secure location
- Configure that location in mycroft.conf, like so:
"stt": {
"google_cloud": {
"credential" {
"json": { contents of downloaded credentials }
}
}
}
It's worth noting that the Cloud Speech API has a free quota of
60 minutes per month, which would probably stretch further than 50
individual requests. So for hobbyists, it should be nothing but
a net benefit.
[1] http://www.chromium.org/developers/how-tos/api-keys
[2] https://github.com/Uberi/speech_recognition/blob/master/reference/library-reference.rst#recognizer_instancerecognize_googleaudio_data-key--none-language--en-us-show_all--false
Significant edit:
* Remove mentions of old start.sh / mycroft.sh
* Enhanced getting started instructions with more explicit steps
* Reorganized to place most commonly wanted information up front.
* Syntax, layout, and typo repairs.
Fixed a bunch of spelling errors, punctuation problems, and layout inconsistencies. Clarified some of the language. Added a link to the `screen` man page.
* Chat link update
Added: https://mycroft.ai/to/chat/
* Added home.mycroft.ai as config option
* Capitalization and small syntax edits
* Noticed that FAQ/Common Errors section of README.md said that mycroft.sh would start the cli, so I added it.
* changed three to four for FAQ since four processes are listed.
* added --quiet option to start.sh cli to prevent echo when using the cli
* per @the7erm sugestion: changed the log flush to 1 second for screen.
* modified mycroft.sh to support starting in three modes:
- service, skills, voice, cli --quiet
- service skills, voice
- service skills, cli
* Added changes to quick start to reflect changes to mycroft.sh
Åke Forslund
Bart Ribbers
Kris Gesling
Chris Veilleux
Brian J. Tarricone
Moritz Glöckl
Steve Penrod
Steve Penrod
Niels Mündler
Matthew D. Scholefield
Seenivasan M
KathyReid
Andrew Hayworth
Harald Sitter
Matthew D. Scholefield
Michael Nguyen
Augusto Monteiro
vavrek
kfezer
Jonathan D'Orleans
chrisvella
Jason Hines
Ethan Ward
RobodudeMC
Travis Burandt