diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..6b3e365 --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +#Blather +Blather is a speech recognizer that will run commands when a user speaks preset sentences. + +##Requirements +1. pocketsphinx +2. gstreamer-0.10 (and what ever plugin has pocket sphinx support) +3. gstreamer-0.10 base plugins (required for alsa) +4. pyside (only required for the Qt based UI) +5. pygtk (only required for the Gtk based UI) +6. pyyaml (only required for reading the options file) + +##Usage +0. move commands.tmp to ~/.config/blather/commands.conf and fill the file with sentences and command to run +1. Run Blather.py, this will generate ~/.config/blather/sentences.corpus based on sentences in the 'commands' file +2. quit blather (there is a good chance it will just segfault) +3. go to <http://www.speech.cs.cmu.edu/tools/lmtool.html> and upload the sentences.corpus file +4. download the resulting XXXX.lm file to the ~/.config/blather/language directory and rename to file to 'lm' +5. download the resulting XXXX.dic file to the ~/.config/blather/language directory and rename to file to 'dic' +6. run Blather.py + * for Qt GUI, run Blather.py -i q + * for Gtk GUI, run Blather.py -i g + * to start a UI in 'continuous' listen mode, use the -c flag + * to use a microphone other than the system default, use the -m flag +7. start talking + +**Note:** to start Blather without needing to enter command line options all the time, copy options.yaml.tmp to ~/.config/blather/options.yaml and edit accordingly. + +###Bonus +once the sentences.corpus file has been created, run the language_updater.sh script to automate the process of creating and downloading language files. + +###Examples +To run blather with the GTK UI and start in continuous listen mode: +`./Blather.py -i g -c` + +To run blather with no UI and using a USB microphone recognized and device 2: +`./Blather.py -m 2` + +###Finding the Device Number of a USB microphone +There are a few ways to find the device number of a USB microphone. + +* `cat /proc/asound/cards` +* `arecord -l` |