diff options
author | Clayton G. Hobbs <clay@lakeserv.net> | 2015-12-26 22:51:45 -0500 |
---|---|---|
committer | Clayton G. Hobbs <clay@lakeserv.net> | 2015-12-26 22:51:45 -0500 |
commit | 4c20e7d7ca1b9392e3b5a303eef3b5fa71f2b833 (patch) | |
tree | 81831c0fbbeaae1c160c5fc46b1c4309ea7081a8 | |
parent | f176a2a9e307a77cdb0ce605a7fa946e4985aba1 (diff) |
More changes to README
This fork is called Kaylee, not Blather. Let's at least be consistent with referring to the program as Kaylee, even if the code is still in blather.py.
-rw-r--r-- | README.md | 54 |
1 files changed, 31 insertions, 23 deletions
diff --git a/README.md b/README.md index cecd1e9..f0bca34 100644 --- a/README.md +++ b/README.md @@ -18,45 +18,53 @@ but adds a lot of features that go beyond the original purpose of Blather. ## 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 Gtk GUI, run Blather.py -i g +1. Move commands.tmp to ~/.config/blather/commands.conf and fill the file with +sentences and command to run +2. Run blather.py, this will generate ~/.config/blather/sentences.corpus based +on sentences in the 'commands' file +3. Quit Kaylee (there is a good chance it will just segfault) +4. Go to <http://www.speech.cs.cmu.edu/tools/lmtool.html> and upload the +sentences.corpus file +5. Download the resulting XXXX.lm file to the ~/.config/blather/language +directory and rename to file to 'lm' +6. Download the resulting XXXX.dic file to the ~/.config/blather/language +directory and rename to file to 'dic' +7. Run blather.py + * For GTK UI, 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 +8. 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. +**Note:** to start Kaylee 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. +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 Kaylee 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` +* To run Kaylee with no UI and using a USB microphone recognized and device 2: +`./blather.py -m 2` -* To have blather pass the matched sentence to the executing command: - `./Blather.py -p` +* To have Kaylee pass the matched sentence to the executed command: +`./blather.py -p` - **explanation:** if the commands.conf contains: - **good morning world : example_command.sh** - then 3 arguments, 'good', 'morning', and 'world' would get passed to example_command.sh as - `example_command.sh good morning world` +**explanation:** if the commands.conf contains: +`good morning world: example_command.sh` +then 3 arguments, 'good', 'morning', and 'world' would get passed to +example_command.sh as `example_command.sh good morning world` * To run a command when a valid sentence has been detected: - `./Blather.py --valid-sentence-command=/path/to/command` + `./blather.py --valid-sentence-command=/path/to/command` **note:** this can be set in the options.yml file * To run a command when a invalid sentence has been detected: - `./Blather.py --invalid-sentence-command=/path/to/command` + `./blather.py --invalid-sentence-command=/path/to/command` **note:** this can be set in the options.yml file ### Finding the Device Number of a USB microphone |