Simplify readme

This commit is contained in:
Anton Osika
2023-06-18 23:30:15 +02:00
parent c762c4ec86
commit 628a012cf0
2 changed files with 25 additions and 50 deletions

View File

@@ -20,9 +20,9 @@ help:
@echo " dev-install Will install the dev dependencies too."
@echo " run <folder_name> Runs GPT Engineer on the folder with the given name."
dev-install: create-venv upgrade-pip install-dependencies install-pre-commit farewell
dev-install: install
install: create-venv upgrade-pip install-dependencies farewell
install: create-venv upgrade-pip install-dependencies install-pre-commit farewell
create-venv:
@echo -e "$(COLOR_CYAN)Creating virtual environment...$(COLOR_RESET)" && \
@@ -36,7 +36,7 @@ upgrade-pip:
install-dependencies:
@echo -e "$(COLOR_CYAN)Installing dependencies...$(COLOR_RESET)" && \
source venv/bin/activate && \
pip install -r requirements.txt >> /dev/null
pip install -e . >> /dev/null
install-pre-commit:
@echo -e "$(COLOR_CYAN)Installing pre-commit hooks...$(COLOR_RESET)" && \

View File

@@ -14,59 +14,34 @@ GPT Engineer is made to be easy to adapt, extend, and make your agent learn how
- Fast handovers back and forth between AI and human
- Simplicity, all computation is "resumable" and persisted to the filesystem
## Installation
**Users**:
We recommend installing from PyPi:
```bash
pip install gpt-engineer
```
This will make sure you are running the latest stable version.
**Contributors/Developers**:
If you plan on becoming a [contributor](.github/CONTRIBUTING.md) or if you just want to test/develop something on top of things,
you can install from GitHub the bleeding version, aka the `main` branch:
_(be aware this is a very active project and might be unstable at times)_
```bash
# use make (run make --help to see all commands available)
make install
# or
make dev-install # if you plan to contribute
```
If you know your way around Python project you can also install manually (make sure you are in a virtual environment):
```
pip install -r requirements.txt
```
## Usage
**Setup**:
Choose either **stable** or **development**.
For **stable** release:
- `pip install gpt-engineer`
For **development**:
- `git clone git@github.com:AntonOsika/gpt-engineer.git`
- `cd gpt-engineer`
- `make install`
- `source venv/bin/activate`
**Setup**
With an api key that has GPT4 access run:
- `export OPENAI_API_KEY=[your api key]`
- setup your OpenAI API Key (with a key that has GPT4 access)
```
export OPENAI_API_KEY=[your api key]
```
**Run**:
- Create a new empty folder with a `main_prompt` file in the `projects` folder or copy the example folder:
```
cp -r projects/example/ projects/my-new-project
```
- Create an empty folder. If inside the repo, you can run:
- `cp -r projects/example/ projects/my-new-project`
- Fill in the `main_prompt` file in your new folder
- Run: `gpt-engineer projects/my-new-project`
- Fill in the `main_prompt` in your new folder
- Run `python -m gpt_engineer.main projects/my-new-project`
**Results**:
**Results**
- Check the generated files in `projects/my-new-project/workspace`
### Limitations