Update README.md

This commit is contained in:
SevaSk 2023-05-13 20:30:19 -04:00 committed by GitHub
parent 43f7ece668
commit 968882f79e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,11 +1,55 @@
# ecoute
# install instructions:
git clone https://github.com/SevaSk/ecoute
## 🚀 Getting Started
in ecoute folder:
Follow these steps to set up and run ecoute on your local machine.
pip install -r requirments.txt
### 📋 Prerequisites
create keys.py file and fill it with the line OPENAI_API_KEY = "API KEY" where "API KEY" will be a string containing your open AI api key
- Python 3.x
- An OpenAI API key
### 🔧 Installation
1. Clone the repository:
```
git clone https://github.com/SevaSk/ecoute
```
2. Navigate to the `ecoute` folder:
```
cd ecoute
```
3. Install the required packages:
```
pip install -r requirements.txt
```
4. Create a `keys.py` file and add your OpenAI API key:
```
echo 'OPENAI_API_KEY = "API KEY"' > keys.py
```
Replace `API KEY` with your actual OpenAI API key.
### 🎬 Running ecoute
Run the main script:
```
python main.py
```
Now, ecoute will start transcribing your microphone input and speaker output in real-time, and provide a suggested response based on the conversation.
## 📖 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 🤝 Contributing
Contributions are welcome! Feel free to open issues or submit pull requests to improve ecoute.
```