readme: update & include recent in the changelog

ideasman42 · Feb 9, 2023 · ddac32a · ddac32a
1 parent ae3053d
commit ddac32a
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/changelog.rst b/changelog.rst
@@ -3,6 +3,8 @@
 Changelog
 #########
 
+- 2023/02/09: Add ``--vosk-grammar-file`` allowing a restricted set of words.
+- 2023/02/09: Use ``SIGHUB`` to reload the user configuration at run-time.
 - 2023/02/02: Add ``--suspend-on-start`` argument to the ``begin`` sub-command.
 - 2023/02/02: Add ``suspend`` & ``resume`` sub-commands for process level suspend/resume.
 - 2022/11/03: Add ``dotool`` support with ``--simpulate-input-tool=DOTOOL``.

diff --git a/nerd-dictation b/nerd-dictation
@@ -1522,7 +1522,7 @@ def argparse_create_begin(subparsers: "argparse._SubParsersAction[argparse.Argum
         help=(
             "Path to a JSON grammar file.  This restricts the phrases recognized by VOSK for\n"
             "better accuracy.  See `vosk_recognizer_new_grm` in the API reference:\n"
-            "  https://github.com/alphacep/vosk-api/blob/master/src/vosk_api.h"
+            "https://github.com/alphacep/vosk-api/blob/master/src/vosk_api.h"
         ),
         required=False,
     )

diff --git a/readme.rst b/readme.rst
@@ -201,7 +201,7 @@ Subcommand: ``begin``
 usage::
 
        nerd-dictation begin [-h] [--cookie FILE_PATH] [--config FILE]
-                            [--vosk-model-dir DIR]
+                            [--vosk-model-dir DIR] [--vosk-grammar-file DIR]
                             [--pulse-device-name IDENTIFIER]
                             [--sample-rate HZ] [--defer-output] [--continuous]
                             [--timeout SECONDS] [--idle-time SECONDS]
@@ -223,6 +223,10 @@ options:
   --config FILE         Override the file used for the user configuration.
                         Use an empty string to prevent the users configuration being read.
   --vosk-model-dir DIR  Path to the VOSK model, see: https://alphacephei.com/vosk/models
+  --vosk-grammar-file DIR
+                        Path to a JSON grammar file.  This restricts the phrases recognized by VOSK for
+                        better accuracy.  See `vosk_recognizer_new_grm` in the API reference:
+                        https://github.com/alphacep/vosk-api/blob/master/src/vosk_api.h
   --pulse-device-name IDENTIFIER
                         The name of the pulse-audio device to use for recording.
                         See the output of "pactl list sources" to find device names (using the identifier following "Name:").