Skip to content

Commit

Permalink
Contained getting started section in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ATheorell committed Dec 19, 2023
1 parent 891dd2c commit 6d76e98
Showing 1 changed file with 4 additions and 8 deletions.
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ GPT-engineer lets you:
- Sit back and watch as an AI writes and executes the code
- Ask the AI to implement improvements

**Specify what software you want to build — the AI builds it for you.**
## Getting Started

## Setup
### Install gpt-engineer

For **stable** release:

Expand All @@ -25,7 +25,7 @@ For **development**:

We actively support Python 3.10 - 3.11.

**API Key**
### Setup API Key

Choose **one** of:
- Export env variable (you can add this to .bashrc so that you don't have to do it each time you start the terminal)
Expand All @@ -43,11 +43,7 @@ Check the [Windows README](./WINDOWS_README.md) for windows usage.
- Do everything in your browser:
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/AntonOsika/gpt-engineer/codespaces)

## Usage

There are two ways to work with GPT-engineer: new code mode (the default), and improve existing code mode (the `-i` option).

### Creating new code
### Creating new code (defualt usage)
- Create an empty folder for your project anywhere on your computer
- Create a file called `prompt` (no extension) inside your new folder and fill it with instructions
- Run `gpte <project_dir>` with a relative path to your folder
Expand Down

0 comments on commit 6d76e98

Please sign in to comment.