|
@@ -18,20 +18,19 @@ but adds a lot of features that go beyond the original purpose of Blather.
|
18
|
18
|
|
19
|
19
|
## Usage
|
20
|
20
|
|
21
|
|
-1. Move commands.tmp to ~/.config/kaylee/commands.conf and fill the file with
|
22
|
|
-sentences and commands to run
|
|
21
|
+1. Move options.json.tmp to ~/.config/kaylee/options.json and fill the
|
|
22
|
+ "commands" section of the file with sentences to speak and commands to run.
|
23
|
23
|
2. Run kaylee.py. This will generate ~/.local/share/kaylee/sentences.corpus
|
24
|
|
-based on sentences in the 'commands' file, then use the [Sphinx Knowledge Base
|
25
|
|
-Tool](http://www.speech.cs.cmu.edu/tools/lmtool.html) to create and save a new
|
26
|
|
-language model and dictionary.
|
|
24
|
+ based on sentences in the "commands" section of options.json, then use the
|
|
25
|
+ [Sphinx Knowledge Base Tool](http://www.speech.cs.cmu.edu/tools/lmtool.html)
|
|
26
|
+ to create and save a new language model and dictionary.
|
27
|
27
|
* For GTK UI, run kaylee.py -i g
|
28
|
28
|
* To start a UI in 'continuous' listen mode, use the -c flag
|
29
|
29
|
* To use a microphone other than the system default, use the -m flag
|
30
|
|
-3. Start talking
|
|
30
|
+3. Start talking!
|
31
|
31
|
|
32
|
|
-**Note:** to start Kaylee without needing to enter command line options all the
|
33
|
|
-time, copy options.json.tmp to ~/.config/kaylee/options.json and edit
|
34
|
|
-accordingly.
|
|
32
|
+**Note:** default values for command-line arguments may be specified in the
|
|
33
|
+options.json file.
|
35
|
34
|
|
36
|
35
|
### Examples
|
37
|
36
|
|
|
@@ -41,15 +40,8 @@ accordingly.
|
41
|
40
|
* To run Kaylee with no UI and using a USB microphone recognized as device 2:
|
42
|
41
|
`./kaylee.py -m 2`
|
43
|
42
|
|
44
|
|
-* To have Kaylee pass the matched sentence to the executed command:
|
45
|
|
- `./kaylee.py -p`
|
46
|
|
-
|
47
|
|
- **Explanation:** if the commands.conf contains the line:
|
48
|
|
-
|
49
|
|
- good morning world: example_command.sh
|
50
|
|
-
|
51
|
|
- Then three arguments, 'good', 'morning', and 'world', would get passed to
|
52
|
|
- example_command.sh as `example_command.sh good morning world`.
|
|
43
|
+* To have Kaylee pass each word of the matched sentence as a separate argument
|
|
44
|
+ to the executed command: `./kaylee.py -p`
|
53
|
45
|
|
54
|
46
|
* To run a command when a valid sentence has been detected:
|
55
|
47
|
`./kaylee.py --valid-sentence-command=/path/to/command`
|