aljaz/gpt-engineer
1
0
Fork 0
mirror of https://github.com/aljazceru/gpt-engineer.git synced 2025-12-18 13:15:00 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add gif, remove obvious lines and make instructions less "magic" in readme

Browse Source
This commit is contained in:
Anton Osika
2023-06-16 22:26:27 +02:00
committed by GitHub
parent 25a6c31d4f
commit fb9a35846a
1 changed files with 2 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -2,6 +2,7 @@
**Specify what you want it to build, the AI asks for clarification, and then builds it.** **Specify what you want it to build, the AI asks for clarification, and then builds it.**
GPT Engineer is made to be easy to adapt, extend, and make your agent learn how you want your code to look. It generates an entire codebase based on a prompt. GPT Engineer is made to be easy to adapt, extend, and make your agent learn how you want your code to look. It generates an entire codebase based on a prompt.
![output](https://github.com/AntonOsika/gpt-engineer/assets/4467025/a6938d43-2ac1-4cf1-98d1-93eea1bdfce4)
## Project philosophy ## Project philosophy
@@ -17,15 +18,13 @@ GPT Engineer is made to be easy to adapt, extend, and make your agent learn how
## Usage ## Usage
**Setup**: **Setup**:
- `git clone https://github.com/AntonOsika/gpt-engineer.git`
- `cd gpt-engineer`
- `pip install .` - `pip install .`
- `export OPENAI_API_KEY=[your api key]` with a key that has GPT4 access - `export OPENAI_API_KEY=[your api key]` with a key that has GPT4 access
**Run**: **Run**:
- Create a new empty folder with a `main_prompt` file (or copy the example folder `cp -r example/ my-new-project`) - Create a new empty folder with a `main_prompt` file (or copy the example folder `cp -r example/ my-new-project`)
- Fill in the `main_prompt` in your new folder - Fill in the `main_prompt` in your new folder
- Run `gpt-engineer my-new-project` - Run `python gpt-engineer/main.py my-new-project`
**Results**: **Results**:
- Check the generated files in my-new-project/workspace - Check the generated files in my-new-project/workspace
@@ -47,7 +46,4 @@ Each step in steps.py will have its communication history with GPT4 stored in th
## Demo ## Demo
https://github.com/AntonOsika/gpt-engineer/assets/4467025/6e362e45-4a94-4b0d-973d-393a31d92d9b https://github.com/AntonOsika/gpt-engineer/assets/4467025/6e362e45-4a94-4b0d-973d-393a31d92d9b