Update README.md

enoobis · Jan 22, 2023 · e6c7b8c · e6c7b8c
1 parent 0991195
commit e6c7b8c
Showing 1 changed file with 28 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,2 +1,29 @@
 # voice-chatgpt-python
-This project is a conversational AI program that uses speech recognition, text-to-speech, and the OpenAI API to generate responses to user prompts, allowing for a natural conversation flow.
+
+This program is a speech recognition and text-to-speech program that utilizes the OpenAI API to generate responses to user prompts.
+
+## Requirements
+- Python 3.x
+- SpeechRecognition
+- pyttsx3
+- OpenAI API key
+- portaudio (for pyaudio)
+
+## Installation
+1. Install Python 3.x
+2. Install the required libraries by running the following command:
+```
+pip install speech_recognition pyttsx3 openai
+```
+3. Install portaudio by running the following command:
+```
+pip install portaudio
+```
+4. Get an OpenAI API key from [OpenAI](https://beta.openai.com/signup/).
+
+## Usage
+1. Run the program by executing the following command:
+```
+python voicechatgpt.py
+```
+2. Speak into the microphone when prompted.