Skip to content

Commit

Permalink
Shorten readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AntonOsika committed Jul 16, 2023
1 parent 02f6e49 commit df5807f
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 15 deletions.
21 changes: 9 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**:

Expand All @@ -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!
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).
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](.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.

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.

## Example

Expand Down
9 changes: 6 additions & 3 deletions WINDOWS_README.md
Original file line number Diff line number Diff line change
@@ -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**.

Expand Down

0 comments on commit df5807f

Please sign in to comment.