diff options
| author | Clayton G. Hobbs <clay@lakeserv.net> | 2016-05-31 15:33:32 -0400 |
|---|---|---|
| committer | Clayton G. Hobbs <clay@lakeserv.net> | 2016-05-31 15:33:32 -0400 |
| commit | a4c186b826c93765f0281ad28ff753a0d75fcc88 (patch) | |
| tree | e4e4038f7773492a7b5e87837c707431216df385 | |
| parent | 3128e3a172bb7189549d4d1b77f1b900bb3a26b2 (diff) | |
A bit of cleanup in the README
It actually does do the things claimed in the first sentence, so don't use the future tense. There's no need to tell the user the details of intermediate steps in generating the language. All the user needs to know is that it uses the network to update the language model when it starts.
| -rw-r--r-- | README.rst | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/README.rst b/README.rst index c07c630..7674312 100644 --- a/README.rst +++ b/README.rst @@ -1,8 +1,8 @@ Kaylee ====== -Kaylee is a somewhat fancy speech recognizer that will run commands and -perform other functions when a user speaks loosely preset sentences. It +Kaylee is a somewhat fancy speech recognizer that runs commands and +performs other functions when a user speaks loosely preset sentences. It is based on `Blather <https://gitlab.com/jezra/blather>`__ by `Jezra <http://www.jezra.net/>`__, but adds a lot of features that go beyond the original purpose of Blather. @@ -26,15 +26,15 @@ Usage 1. Copy options.json.tmp to ~/.config/kaylee/options.json and fill the "commands" section of the file with sentences to speak and commands to run. -2. Run kaylee.py. This will generate - ~/.local/share/kaylee/sentences.corpus based on sentences in the - "commands" section of options.json, then use the `Sphinx Knowledge - Base Tool <http://www.speech.cs.cmu.edu/tools/lmtool.html>`__ to - create and save a new language model and dictionary. - - - For GTK UI, run kaylee.py -i g - - To start a UI in 'continuous' listen mode, use the -c flag - - To use a microphone other than the system default, use the -m flag +2. Run Kaylee with ``./kaylee.py``. This generates a language model and + dictionary using the `Sphinx Knowledge Base Tool + <http://www.speech.cs.cmu.edu/tools/lmtool.html>`__, then listens for + commands with the system default microphone. + + - For the GTK UI, run ``./kaylee.py -i g``. + - To start a UI in 'continuous' listen mode, use the ``-c`` flag. + - To use a microphone other than the system default, use the ``-m`` + flag. 3. Start talking! |