Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add instructions for installing from source to README #3

Merged
merged 1 commit into from
May 18, 2023
Merged

Add instructions for installing from source to README #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@ You can find more chat transcripts on the [examples page](https://aider.chat/exa

## Installation

1. Install the package: `pip install git+https://github.com/paul-gauthier/aider.git`
1. Install the package:
* From Github: `pip install git+https://github.com/paul-gauthier/aider.git`
* Or, from local source: `pip3 install -e ./` (executed from root of repository)
2. Set up your OpenAI API key as an environment variable `OPENAI_API_KEY` or by including it in a `.env` file.

## Usage
Expand Down Expand Up @@ -104,3 +106,4 @@ You might consider refactoring your code into more, smaller files (which is usua
You can use `aider` to help perform such refactorings, if you start before the files get too large.

If you have access to gpt-4-32k, I would be curious to hear how it works with aider.