Merge pull request #1118 from sweetlilmre/readme-cleanup

Readme cleanup
pull/1326/head
Pi 2023-04-14 14:46:31 +01:00 committed by GitHub
commit 9706ae8611
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 7 deletions

View File

@ -69,11 +69,12 @@ Your support is greatly appreciated
- [vscode + devcontainer](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers): It has been configured in the .devcontainer folder and can be used directly
- [Python 3.8 or later](https://www.tutorialspoint.com/how-to-install-python-in-windows)
- [OpenAI API key](https://platform.openai.com/account/api-keys)
- [PINECONE API key](https://www.pinecone.io/)
Optional:
- [ElevenLabs Key](https://elevenlabs.io/) (If you want the AI to speak)
- [PINECONE API key](https://www.pinecone.io/) (If you want Pinecone backed memory)
- ElevenLabs Key (If you want the AI to speak)
## 💾 Installation
@ -124,8 +125,8 @@ pip install -r requirements.txt
python scripts/main.py
```
2. After each of AUTO-GPT's actions, type "NEXT COMMAND" to authorise them to continue.
3. To exit the program, type "exit" and press Enter.
2. After each of action, enter 'y' to authorise command, 'y -N' to run N continuous commands, 'n' to exit program, or enter additional feedback for the AI.
### Logs
@ -228,7 +229,10 @@ Pinecone enables the storage of vast amounts of vector-based memory, allowing fo
### Setting up environment variables
Simply set them in the `.env` file.
In the `.env` file set:
- `PINECONE_API_KEY`
- `PINECONE_ENV` (something like: us-east4-gcp)
- `MEMORY_BACKEND=pinecone`
Alternatively, you can set them from the command line (advanced):
@ -237,7 +241,7 @@ For Windows Users:
```
setx PINECONE_API_KEY "YOUR_PINECONE_API_KEY"
setx PINECONE_ENV "Your pinecone region" # something like: us-east4-gcp
setx MEMORY_BACKEND "pinecone"
```
For macOS and Linux users:
@ -245,7 +249,7 @@ For macOS and Linux users:
```
export PINECONE_API_KEY="YOUR_PINECONE_API_KEY"
export PINECONE_ENV="Your pinecone region" # something like: us-east4-gcp
export MEMORY_BACKEND="pinecone"
```
## Setting Your Cache Type