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

Shorten readme

Browse Source
This commit is contained in:
Anton Osika
2023-07-16 17:55:56 +02:00
parent 02f6e4911b
commit df5807f184
2 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@@ -42,8 +42,6 @@ With an OpenAI API key (preferably with GPT-4 access) run:
- `export OPENAI_API_KEY=[your api key]`
Alternative for Windows
- `set OPENAI_API_KEY=[your api key]` on cmd
- `$env:OPENAI_API_KEY="[your api key]"` on powershell
**Run**:
@@ -58,33 +56,32 @@ By running gpt-engineer you agree to our [terms](https://github.com/AntonOsika/g
**Results**
- Check the generated files in `projects/my-new-project/workspace`
## Getting Started with GitHub Codespaces
To get started, create a codespace for this repository by clicking this 👇
To **run in the browser** you can simply:
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/AntonOsika/gpt-engineer/codespaces)
## Features
You can specify the "identity" of the AI agent by editing the files in the `preprompts` folder.
Editing the `preprompts`, and evolving how you write the project prompt, is currently how you make the agent remember things between projects.
Editing the `preprompts`, and evolving how you write the project prompt, is how you make the agent remember things between projects.
Each step in `steps.py` will have its communication history with GPT4 stored in the logs folder, and can be rerun with `scripts/rerun_edited_message_logs.py`.
## Contributing
## Vision
The gpt-engineer community is building the **open platform for devs to tinker with and build their personal code-generation toolbox**.
If you are interested in contributing to this, we would be interested in having you!
You can check for good first issues [here](https://github.com/AntonOsika/gpt-engineer/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).
Contributing document [here](.github/CONTRIBUTING.md).
We are currently looking for more maintainers and community organisers. Email anton.osika@gmail.com if you are interested in an official role.
If you are interested in contributing to this, we would be interested in having you.
If you want to see our broader ambitions, check out the [roadmap](https://github.com/AntonOsika/gpt-engineer/blob/main/ROADMAP.md), and join
[discord](https://discord.gg/8tcDQ89Ej2)
to get input on how you can contribute to it.
to get input on how you can [contribute](.github/CONTRIBUTING.md) to it.
We are currently looking for more maintainers and community organisers. Email anton.osika@gmail.com if you are interested in an official role.
## Example

9
WINDOWS_README.md
View File

@@ -1,8 +1,11 @@
# Windows Usage
# Windows Setup
## Short version
These instructions are for Windows systems. For Unix, go [here](https://github.com/AntonOsika/gpt-engineer/blob/main/README.md).
On Windows, follow the standard [README.md](https://github.com/AntonOsika/gpt-engineer/blob/main/README.md), but to set API key do one of:
- `set OPENAI_API_KEY=[your api key]` on cmd
- `$env:OPENAI_API_KEY="[your api key]"` on powershell
## Usage
## Full setup guide
Choose either **stable** or **development**.