☝️ Update README.md #865
Merged
☝️ Update README.md #865
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
**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.
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.
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** |
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.
I think this is too much info, can be explained in a video if anything
README.md
Outdated
Comment on lines
67
to
68
| 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.
Need clone instructions, should probably inline the Max / windows stuff
README.md
Outdated
Comment on lines
76
to
92
|
|
||
| ```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.
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.
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.