Update README.md

README.md

@@ -42,16 +42,27 @@ Before running this project, make sure you have the following dependencies insta
 - FAISS
 - Ollama
 
-Create an Conda environment
+# How to gt started with project
+
+1. Clone this repository.
+```
+git clone https://huggingface.co/foduucom/Voice-Assistant-using-RAG
+```
+2. Create conda environment.
 ```
 conda create -n VoiceAI python==3.10
 conda activate VoiceAI
 ```
-You can install most of these dependencies using pip:
+3. You can install most of these dependencies using pip:
+```
+pip install -r requirements.txt
+```
+or
 ```
 pip install torch transformers speechrecognition pyttsx3 soundfile playsound TTS langchain faiss-cpu
 ```
 
+
 For Ollama, follow the installation instructions on their official website https://ollama.com/library/llama3.
 
 ## Setup
@@ -66,7 +77,7 @@ For Ollama, follow the installation instructions on their official website https
 To run the voice assistant, execute the following command in your terminal:
 
 ```
-python voice_assistant.py
+python Voice_Assistant.py
 ```
 
 The assistant will start listening for your voice input. Speak clearly into your microphone to ask questions or give commands. The assistant will process your input and respond with synthesized speech.
@@ -85,7 +96,7 @@ The assistant will start listening for your voice input. Speak clearly into your
 - To use a different knowledge base, replace `KnowledgeBase.pdf` with your own PDF file and update the filename in the script.
 - You can experiment with different embedding models by changing the `model_name` in the `HuggingFaceEmbeddings` initialization.
 - To use a different Ollama model, update the `model` parameter in the `Ollama` initialization.
-- Try to use other TTS frameworks - MeloTTS, coquiTTS, Mars5TTS.
+- Try to use other TTS frameworks - Melo TTS, coqui TTS, Mars5 TTS.
 
 ## Troubleshooting