Browse Source

Updated the README to better reflect the new UIs

Jezra 11 years ago
parent
commit
a14686b782
1 changed files with 13 additions and 10 deletions
  1. 13
    10
      README

+ 13
- 10
README View File

@@ -1,20 +1,23 @@
1
-Requirements
2
-===========
1
+#Blather
2
+Blather is a speech recognizer that will run commands when a user speaks preset sentences. 
3 3
 
4
-pocketsphinx	
5
-gstreamer (and what ever plugin has pocket sphinx support)
6
-pyside (only required for the Qt based UI)
4
+##Requirements
5
+1. pocketsphinx	
6
+2. gstreamer (and what ever plugin has pocket sphinx support)  
7
+3. pyside (only required for the Qt based UI)
8
+4. pygtk (only required for the Gtk based UI)
7 9
 
10
+##Usage
8 11
 0. move commands.tmp to ~/.config/blather/commands and fill the file with sentences and command to run
9
-
10
-1. Run blather.py, this will generate ~/.config/blather/sentences.corpus based on sentences in the 'commands' file
12
+1. Run Blather.py, this will generate ~/.config/blather/sentences.corpus based on sentences in the 'commands' file
11 13
 2. quit blather (there is a good chance it will just segfault)
12 14
 3. go to <http://www.speech.cs.cmu.edu/tools/lmtool-new.html> and upload the sentences.corpus file
13 15
 4. download the resulting XXXX.lm file to the ~/.config/blather/language directory and rename to file to 'lm'
14 16
 5. download the resulting XXXX.dic file to the ~/.config/blather/language directory and rename to file to 'dic'
15
-6. run blather.py
16
-    * for Qt GUI, run blather.py -qt
17
+6. run Blather.py
18
+    * for Qt GUI, run Blather.py -qt
19
+    * for Gtk GUI, run Blather.py -gtk
17 20
 7. start talking
18 21
 
19 22
 ####Bonus
20
-once the sentences.corpus file has been created, run the language_updater.sh to automate the process of creating and downloading language files.
23
+once the sentences.corpus file has been created, run the language_updater.sh script to automate the process of creating and downloading language files.

Loading…
Cancel
Save