summary refs log tree commit diff
diff options
context:
space:
mode:
authorJezra <jezra@jezra.net>2013-04-19 11:29:13 -0700
committerJezra <jezra@jezra.net>2013-04-19 11:29:13 -0700
commita14686b782b16740d9ee4a287efc4a5417ca1a9e (patch)
tree2bcd8338976a161aa7f2983f4c5687baa8bc5b15
parentc61a0c311fa2a795f9369cf94988b0c7c7ff3973 (diff)
Updated the README to better reflect the new UIs
-rw-r--r--README23
1 files changed, 13 insertions, 10 deletions
diff --git a/README b/README
index 4df3169..8e70d2b 100644
--- a/README
+++ b/README
@@ -1,20 +1,23 @@
-Requirements
-===========
+#Blather
+Blather is a speech recognizer that will run commands when a user speaks preset sentences. 
 
-pocketsphinx	
-gstreamer (and what ever plugin has pocket sphinx support)
-pyside (only required for the Qt based UI)
+##Requirements
+1. pocketsphinx	
+2. gstreamer (and what ever plugin has pocket sphinx support)  
+3. pyside (only required for the Qt based UI)
+4. pygtk (only required for the Gtk based UI)
 
+##Usage
 0. move commands.tmp to ~/.config/blather/commands 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
+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-new.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 -qt
+6. run Blather.py
+    * for Qt GUI, run Blather.py -qt
+    * for Gtk GUI, run Blather.py -gtk
 7. start talking
 
 ####Bonus
-once the sentences.corpus file has been created, run the language_updater.sh to automate the process of creating and downloading language files.
\ No newline at end of file
+once the sentences.corpus file has been created, run the language_updater.sh script to automate the process of creating and downloading language files.
\ No newline at end of file