-
-
Notifications
You must be signed in to change notification settings - Fork 9.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
☝️ Update README.md #865
☝️ Update README.md #865
Conversation
**Issue: Difficulty with Initial Setup and Clarity** Users are finding it challenging to get started due to unclear instructions. Some common hurdles include not knowing where the terminal is, how to access it, and what needs to be downloaded beforehand. Along with setup.bat changed to ./setup.bat **Proposed Solution** To improve the clarity and ease of the initial setup process, we could provide more detailed, step-by-step instructions with prerequisite downloads and how to access and use the terminal.
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
README.md
Outdated
|
||
Before you get started, please make sure you have the following installed: | ||
|
||
- [Visual Studio Code (VS Code)](https://code.visualstudio.com/download) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lets not propose any specific editor. Maybe say download the editor of your choice, for example, VSCode
README.md
Outdated
- [Docker](https://www.docker.com/products/docker-desktop) | ||
- An [OpenAI API key](https://beta.openai.com/signup/) | ||
|
||
For Docker, after installation, please create an account, download Docker, and sign in to your account. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lets put this alongside the docker bullet point above
- [Docker](https://www.docker.com/products/docker-desktop). After installation, please create an account, open up the Docker application, and sign in
README.md
Outdated
|
||
## Getting Started :rocket: | ||
|
||
1. **Open VS Code** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Open your editor*
README.md
Outdated
## Getting Started :rocket: | ||
|
||
1. **Open VS Code** | ||
- You can do this by searching for it in your applications or clicking on the shortcut if you have one. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is too much info, can be explained in a video if anything
README.md
Outdated
3. **Clone the Repository and Navigate into the Directory** | ||
- Once your terminal is open, you can clone the repository and move into the directory by running the following commands: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Need clone instructions, should probably inline the Max / windows stuff
README.md
Outdated
|
||
```bash | ||
git clone https://github.com/reworkd/AgentGPT.git | ||
cd AgentGPT | ||
``` | ||
|
||
**Run the Setup File** | ||
- This will set up everything you need for the project. | ||
|
||
For Mac/Linux users :apple: :penguin: | ||
```bash | ||
./setup.sh | ||
``` | ||
If you are on windows, you can do the following after downloading the repo. | ||
For Windows users :windows: | ||
|
||
```bash | ||
./setup.bat |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lets not have a separate thing for Mac/Linux and Windows for every step. We should have one mac section and one windows section
Editor Recommendation: To prevent any potential bias, the recommendation for a specific editor (VSCode) has been replaced with a more generic statement. Users are now advised to use the editor of their choice. Docker Instructions: The instructions for Docker installation and sign-in have been placed alongside the Docker bullet point for better context and readability. Editor Instructions: Rather than specifically instructing users to open VS Code, the updated instructions now simply state to open the user's chosen editor. Prerequisite Information: The details about opening VS Code have been removed from the Prerequisites section. It was suggested that this level of detail might be better suited to a video tutorial. Git Requirement: Git has been added to the list of necessary prerequisites for running AgentGPT. Repository Cloning Instructions: Instructions for cloning the repository have been added to ensure users know how to get the AgentGPT code onto their local machines. Setup Instructions: To streamline the instructions and reduce repetition, separate sections for Mac/Linux and Windows setup steps have been combined into a single section with sub-sections for each OS.
cd AgentGPT | ||
./setup.bat | ||
``` | ||
Happy hacking! :tada: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lets also add. Follow the setup instructions from the script, add the appropriate api keys, and once all of the services are running, travel to http://localhost:3000 on your web-browser
Follow the setup instructions from the script - add the appropriate API keys, and once all of the services are running, travel to http://localhost:3000 on your web-browser.
Issue: Difficulty with Initial Setup and Clarity
Users are finding it challenging to get started due to unclear instructions. Some common hurdles include not knowing where the terminal is, how to access it, and what needs to be downloaded beforehand. Along with setup.bat changed to ./setup.bat
Proposed Solution
To improve the clarity and ease of the initial setup process, we could provide more detailed, step-by-step instructions with prerequisite downloads and how to access and use the terminal.