added short readme

Azumuta · Sep 28, 2020 · 3922e8d · 3922e8d
1 parent 5d53f3c
commit 3922e8d
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,9 @@
 # speech2command
+
+Tool to convert sproken commands to actual commands in Azumuta. Using Kaldi ASR models and Vosk-API.
+
+## Usage
+
+VoskJS.js defines a recognizer for the model and should be loaoded first.
+resultHandling converts the model to actual commands. Commands can be added with `addToCommand(text, command)`, where `command` is the command for Azumuta and text is a list with words (defined in red<LANG>.js).
+To load the English model, load redEn.js; this will load the model and define the appropriate words. To use Dutch, load redNl.js instead.