Merge pull request #3 from mobyvb/update-readme

Add instructions for installing from source to README
This commit is contained in:
paul-gauthier 2023-05-18 13:58:16 -07:00 committed by GitHub
commit 576437dd20
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -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
@ -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.