From 0cc687b6a41dc10b7ad23ae0ec7ff201c05d6168 Mon Sep 17 00:00:00 2001 From: Sameer Rahmani Date: Fri, 15 Apr 2022 23:35:33 +0100 Subject: [PATCH] Update the docs --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3a986b1..d8fc9bb 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,22 @@ # Orion -Orion is a telegram bot that converts voice messages into text and org-mode files. It can be trained for better accuracy. \ No newline at end of file +Orion is a telegram bot that converts voice messages into text and org-mode files. +It can be trained for better accuracy. + +In order to use it, first you need to setup the project which you can just call +`./builder setup` and then you can run Orion via the builder script again with the +following command: + +```bash +./builder run -owner TELEGRAM_ID -model PATH_TO_MODEL -scorer PATH_TO_SCORER +``` +* *TELEGRAM_ID*: Is your telegram id. It will only reply to you and tell others +to F off. + +* *PATH_TO_MODEL(optoinal)*: Is the path to the model file you want to use for speech recognition. +the default points to the default model in the models directory. + +* *PATH_TO_SCORER(optional)*: Is the path to the scorer to be use to speech recognition. +the default points to the default scorer in the models directory. + +Models and scorers should be compatible with [Coqui](https://coqui.ai/).