Browse Source

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.
Clara Hobbs 8 years ago
parent
commit
a4c186b826
1 changed files with 11 additions and 11 deletions
  1. 11
    11
      README.rst

+ 11
- 11
README.rst View File

@@ -1,8 +1,8 @@
1 1
 Kaylee
2 2
 ======
3 3
 
4
-Kaylee is a somewhat fancy speech recognizer that will run commands and
5
-perform other functions when a user speaks loosely preset sentences. It
4
+Kaylee is a somewhat fancy speech recognizer that runs commands and
5
+performs other functions when a user speaks loosely preset sentences. It
6 6
 is based on `Blather <https://gitlab.com/jezra/blather>`__ by
7 7
 `Jezra <http://www.jezra.net/>`__, but adds a lot of features that go
8 8
 beyond the original purpose of Blather.
@@ -26,15 +26,15 @@ Usage
26 26
 1. Copy options.json.tmp to ~/.config/kaylee/options.json and fill the
27 27
    "commands" section of the file with sentences to speak and commands
28 28
    to run.
29
-2. Run kaylee.py. This will generate
30
-   ~/.local/share/kaylee/sentences.corpus based on sentences in the
31
-   "commands" section of options.json, then use the `Sphinx Knowledge
32
-   Base Tool <http://www.speech.cs.cmu.edu/tools/lmtool.html>`__ to
33
-   create and save a new language model and dictionary.
34
-
35
-   -  For GTK UI, run kaylee.py -i g
36
-   -  To start a UI in 'continuous' listen mode, use the -c flag
37
-   -  To use a microphone other than the system default, use the -m flag
29
+2. Run Kaylee with ``./kaylee.py``. This generates a language model and
30
+   dictionary using the `Sphinx Knowledge Base Tool
31
+   <http://www.speech.cs.cmu.edu/tools/lmtool.html>`__, then listens for
32
+   commands with the system default microphone.
33
+
34
+   -  For the GTK UI, run ``./kaylee.py -i g``.
35
+   -  To start a UI in 'continuous' listen mode, use the ``-c`` flag.
36
+   -  To use a microphone other than the system default, use the ``-m``
37
+      flag.
38 38
 
39 39
 3. Start talking!
40 40
 

Loading…
Cancel
Save