Browse Source

Updated README for changes in plugins branch

There's no more pass_words option, so we shouldn't mention that anymore.
Also, commands aren't in a configuration section called "commands"
anymore, so use the new name, ".shell".
Clara Hobbs 7 years ago
parent
commit
7b116a11c4
1 changed files with 1 additions and 4 deletions
  1. 1
    4
      README.rst

+ 1
- 4
README.rst View File

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 and fill the
27
-   "commands" section of the file with sentences to speak and commands
27
+   ".shell" section of the file with sentences to speak and commands
28
    to run.
28
    to run.
29
 2. Run Kaylee with ``./kaylee.py``. This generates a language model and
29
 2. Run Kaylee with ``./kaylee.py``. This generates a language model and
30
    dictionary using the `Sphinx Knowledge Base Tool
30
    dictionary using the `Sphinx Knowledge Base Tool
50
 -  To run Kaylee with no UI and using a USB microphone recognized as
50
 -  To run Kaylee with no UI and using a USB microphone recognized as
51
    device 2: ``./kaylee.py -m 2``
51
    device 2: ``./kaylee.py -m 2``
52
 
52
 
53
--  To have Kaylee pass each word of the matched sentence as a separate
54
-   argument to the executed command: ``./kaylee.py -p``
55
-
56
 -  To run a command when a valid sentence has been detected:
53
 -  To run a command when a valid sentence has been detected:
57
    ``./kaylee.py --valid-sentence-command=/path/to/command``
54
    ``./kaylee.py --valid-sentence-command=/path/to/command``
58
 
55
 

Loading…
Cancel
Save