github/AutoGPT
1
1
Fork 0
mirror of https://github.com/Significant-Gravitas/AutoGPT.git synced 2026-04-30 03:00:41 -04:00
Code Issues Packages Projects Releases Wiki Activity

Fix docs (#3336)

Browse Source 
* Fix docs

* Add short section about testing to contribution guide

* Add back note for voice configuration

* Remove LICENSE symlink from docs/

* Fix site_url in mkdocs.yml
This commit is contained in:
Reinier van der Leer
2023-04-26 20:14:14 +02:00
committed by GitHub
parent 109fa04c7c
commit 76df14b831
14 changed files with 522 additions and 381 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -89,28 +89,20 @@ Your support is greatly appreciated. Development of this free, open-source proje
- 🗃️ File storage and summarization with GPT-3.5
- 🔌 Extensibility with Plugins
## 📋 Requirements
Choose an environment to run Auto-GPT in (pick one):
- [Docker](https://docs.docker.com/get-docker/) (*recommended*)
- Python 3.10 or later (instructions: [for Windows](https://www.tutorialspoint.com/how-to-install-python-in-windows))
- [VSCode + devcontainer](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
## Quickstart
1. Set up your OpenAI [API Keys](https://platform.openai.com/account/api-keys)
1. Get an OpenAI [API Key](https://platform.openai.com/account/api-keys)
2. Download the [latest release](https://github.com/Significant-Gravitas/Auto-GPT/releases/latest)
3. Follow the [installation instructions][docs/install]
3. Follow the [installation instructions][docs/setup]
4. Configure any additional features you want, or install some [plugins][docs/plugins]
5. [Run][docs/usage] the app
Please see the [documentation][docs] linked below for full setup instructions and configuration options.
Please see the [documentation][docs] for full setup instructions and configuration options.
[docs]: https://significant-gravitas.github.io/Auto-GPT/
## 📖 Documentation
* [⚙️ Installation][docs/install]
* [⚙️ Setup][docs/setup]
* [💻 Usage][docs/usage]
* [🔌 Plugins][docs/plugins]
* Configuration
@@ -119,7 +111,7 @@ Please see the [documentation][docs] linked below for full setup instructions an
* [🗣️ Voice (TTS)](https://significant-gravitas.github.io/Auto-GPT/configuration/voice/)
* [🖼️ Image Generation](https://significant-gravitas.github.io/Auto-GPT/configuration/imagegen/)
[docs/install]: https://significant-gravitas.github.io/Auto-GPT/installation/
[docs/setup]: https://significant-gravitas.github.io/Auto-GPT/setup/
[docs/usage]: https://significant-gravitas.github.io/Auto-GPT/usage/
[docs/plugins]: https://significant-gravitas.github.io/Auto-GPT/plugins/