summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorClayton G. Hobbs <clay@lakeserv.net>2016-02-03 23:31:29 -0500
committerClayton G. Hobbs <clay@lakeserv.net>2016-02-03 23:31:29 -0500
commit31731113b6a5000a4e0ce78da013b79cd8c26c80 (patch)
tree5e2ec800156065d668ea8df6cc8b22a391b00d79 /README.md
parent703d2e9fb3033d4d8eeeb30976c2b4fff399f324 (diff)
A few corrections and formatting changes to README
Man, nvim in nvim is trippy.  What's the right way to do this?
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 17 insertions, 16 deletions
diff --git a/README.md b/README.md
index 0b6c2d0..840af58 100644
--- a/README.md
+++ b/README.md
@@ -19,10 +19,10 @@ but adds a lot of features that go beyond the original purpose of Blather.
 ## Usage
 
 1. Move commands.tmp to ~/.config/kaylee/commands.conf and fill the file with
-sentences and command to run
+sentences and commands to run
 2. Run kaylee.py.  This will generate ~/.local/share/kaylee/sentences.corpus
-based on sentences in the 'commands' file, then use
-<http://www.speech.cs.cmu.edu/tools/lmtool.html> to create and save a new
+based on sentences in the 'commands' file, 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
@@ -35,26 +35,27 @@ accordingly.
 
 ### Examples
 
-* To run Kaylee with the GTK UI and start in continuous listen mode:
-`./kaylee.py -i g -c`
+* To run Kaylee with the GTK UI, starting in continuous listen mode:
+  `./kaylee.py -i g -c`
 
-* To run Kaylee with no UI and using a USB microphone recognized and device 2:
-`./kaylee.py -m 2`
+* To run Kaylee with no UI and using a USB microphone recognized as device 2:
+  `./kaylee.py -m 2`
 
 * To have Kaylee pass the matched sentence to the executed command:
-`./kaylee.py -p`
+  `./kaylee.py -p`
 
-**explanation:** if the commands.conf contains:
-`good morning world: example_command.sh`
-then 3 arguments, 'good', 'morning', and 'world' would get passed to
-example_command.sh as `example_command.sh good morning world`
+  **Explanation:** if the commands.conf contains the line:
+
+        good morning world: example_command.sh
+
+  Then three arguments, 'good', 'morning', and 'world', would get passed to
+  example_command.sh as `example_command.sh good morning world`.
 
 * To run a command when a valid sentence has been detected:
-	`./kaylee.py --valid-sentence-command=/path/to/command`
-	**note:** this can be set in the options.yml file
+  `./kaylee.py --valid-sentence-command=/path/to/command`
+
 * To run a command when a invalid sentence has been detected:
-	`./kaylee.py --invalid-sentence-command=/path/to/command`
-	**note:** this can be set in the options.yml file
+  `./kaylee.py --invalid-sentence-command=/path/to/command`
 
 ### Finding the Device Number of a USB microphone
 There are a few ways to find the device number of a USB microphone.