diff --git a/README.md b/README.md index b3d5546..f3b1d2c 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,20 @@ -# Jarvis 2.0 (aka KESHA voice assistant) +# Kesha v3.0 very early (aka Jarvis update) Simple Voice Assistant made as an experiment using [Silero](https://github.com/snakers4/silero-models) & [Vosk](https://pypi.org/project/vosk/). +
Later on [Picovoice Porcupine Wake Word Detection](https://picovoice.ai/platform/porcupine/) & [ChatGPT](https://chat.openai.com/) was added. ![image](https://i.pinimg.com/originals/63/e9/b7/63e9b72b983793f64bffc07fd14a0e62.jpg) +`The code has NOT been polished and is provided "as is". There are a lot of code that are redundant and there are tons of improvements that can be made.` + # Installation -Everything is already configured, just run the `main.py` script.
-Just don't forget to put models of Vosk to main folder.
-You can get the latest from the [official website](https://alphacephei.com/vosk/models). +First, install the requirements, the file is just a `pip freeze` 'k.
+Second, check `config.py` and set required values.
+Next, just run the `main.py` script.

+ +And don't forget to put models of Vosk to main folder.
+You can get the latest from the [official website.](https://alphacephei.com/vosk/models) +
The one I was using is `small`. + # Author (2022) Abraham Tugalov \ No newline at end of file