Browse Source

Updated README for new configuration

Since plugins are configured in a separate file, the README now tells
people to put commands in plugins.json instead of options.json.
Clara Hobbs 7 years ago
parent
commit
474a286dc3
1 changed files with 5 additions and 6 deletions
  1. 5
    6
      README.rst

+ 5
- 6
README.rst View File

23
 Usage
23
 Usage
24
 -----
24
 -----
25
 
25
 
26
-1. Copy options.json.tmp to ~/.config/kaylee/options.json and fill the
26
+1. Copy options.json.tmp to ~/.config/kaylee/options.json.  Default
27
+   values for command-line arguments may be specified in this file.
28
+2. Copy plugins.json.tmp to ~/.config/kaylee/plugins.json and fill the
27
    ".shell" section of the file with sentences to speak and commands
29
    ".shell" section of the file with sentences to speak and commands
28
    to run.
30
    to run.
29
-2. Run Kaylee with ``./kaylee.py``. This generates a language model and
31
+3. Run Kaylee with ``./kaylee.py``. This generates a language model and
30
    dictionary using the `Sphinx Knowledge Base Tool
32
    dictionary using the `Sphinx Knowledge Base Tool
31
    <http://www.speech.cs.cmu.edu/tools/lmtool.html>`__, then listens for
33
    <http://www.speech.cs.cmu.edu/tools/lmtool.html>`__, then listens for
32
    commands with the system default microphone.
34
    commands with the system default microphone.
38
 
40
 
39
 3. Start talking!
41
 3. Start talking!
40
 
42
 
41
-**Note:** default values for command-line arguments may be specified in
42
-the options.json file.
43
-
44
 Examples
43
 Examples
45
 ~~~~~~~~
44
 ~~~~~~~~
46
 
45
 
53
 -  To run a command when a valid sentence has been detected:
52
 -  To run a command when a valid sentence has been detected:
54
    ``./kaylee.py --valid-sentence-command=/path/to/command``
53
    ``./kaylee.py --valid-sentence-command=/path/to/command``
55
 
54
 
56
--  To run a command when a invalid sentence has been detected:
55
+-  To run a command when an invalid sentence has been detected:
57
    ``./kaylee.py --invalid-sentence-command=/path/to/command``
56
    ``./kaylee.py --invalid-sentence-command=/path/to/command``
58
 
57
 
59
 Finding the Device Number of a USB microphone
58
 Finding the Device Number of a USB microphone

Loading…
Cancel
Save