Ported to new pocketsphinx and pygi

Gotta keep that stuff up-to-date, yo.  Pocketsphinx changed so it needs
GStreamer 1.0, and that required rewriting everything to use GObject
Introspection instead of the old, static Python bindings for GObject.

1 files changed, 31 insertions, 28 deletions

diff --git a/README.md b/README.md
index 768f38a..feb0b46 100644
--- a/README.md
+++ b/README.md
@@ -1,61 +1,64 @@
-# Blather
+# Kaylee
 
-Blather is a speech recognizer that will run commands when a user speaks preset sentences.
+Kaylee is a somewhat fancy speech recognizer that will run commands and perform
+other functions when a user speaks loosely preset sentences.  It is based on
+[Blather](https://gitlab.com/jezra/blather) by [Jezra](http://www.jezra.net/),
+but adds a lot of features that go beyond the original purpose of Blather.
 
 ## Requirements
 
 1. pocketsphinx
-2. gstreamer-0.10 (and what ever plugin has pocket sphinx support)
-3. gstreamer-0.10 base plugins (required for alsa)
+2. gstreamer-1.0 (and what ever plugin has pocket sphinx support)
+3. gstreamer-1.0 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)  
+6. pyyaml (only required for reading the options file)
 
 **Note:** it may also be required to install `pocketsphinx-hmm-en-hub4wsj`
 
 
 ## Usage
 
-0. move commands.tmp to ~/.config/blather/commands.conf and fill the file with sentences and command to run
+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
+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.
+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:  
+* 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:  
+* To run blather 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 blather pass the matched sentence to the executing 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  
+ 	**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`  
+* To run a command when a valid sentence has been detected:
+	`./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`  
+* To run a command when a invalid sentence has been detected:
+	`./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