From d082ab2cc80e5c3be2217a54d2ca39e7f93c7a8e Mon Sep 17 00:00:00 2001 From: Guillermo Serrahima Date: Tue, 26 Mar 2024 09:33:04 +0100 Subject: [PATCH] Updated README --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index f55b370..2e797dc 100644 --- a/README.md +++ b/README.md @@ -257,6 +257,22 @@ This argument is required, stating a path to a .wav audio in 8kHz or 16kHz sampl > **THIS FEATURE IS STILL IN DEVELOPMENT, PLEASE USE THE GENERIC TOPIC FOR ALL REQUESTS OR AN ERROR WILL BE GIVEN.** +#### Grammar + +There are three options available to provide a grammar: + +``` +-I, --inline-grammar arg +-G, --grammar-uri arg +-C, --compiled-grammar arg +``` + +- The inline grammar option expects a grammar passed inline as a string. +- The grammar URI option expects a URI, either pointing to a built-in grammar or to a grammar that is being hosted externally. +- The compiled grammar expects a filename of the compiled grammar binary. + +> **THIS FEATURE IS STILL IN DEVELOPMENT, PLEASE ONLY USE THE GRAMMAR URI OPTION WITH BUILTIN GRAMMARS, OR AN ERROR WILL BE GIVEN.** + #### Language ```