From e1df502f34769b46242fd64a0a4897fad1185be0 Mon Sep 17 00:00:00 2001 From: Jevon MacDonald <4289+jevon@users.noreply.github.com> Date: Wed, 31 May 2023 11:46:25 -0300 Subject: [PATCH 1/2] Update README.md Disambiguating the format to include OpenAI API token in ~/.aider.config.yml --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0415cc615..7bdfffa14 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ which helps it understand and modify large codebases. * From GitHub: `pip install git+https://github.com/paul-gauthier/aider.git` * From your local copy of the repo in develop mode to pick up local edits immediately: `pip install -e .` -2. Set up your OpenAI API key as an environment variable `OPENAI_API_KEY` or by including it in an `.aider.config.yml` file (see `aider --help`). +2. Set up your OpenAI API key as an environment variable `OPENAI_API_KEY` or by including `openai-api-key: sk-` in an `.aider.config.yml` file (see `aider --help`). 3. Optionally, install [universal ctags](https://github.com/universal-ctags/ctags). This is helpful if you plan to work with repositories with more than a handful of files. This allows `aider --ctags` to build a [map of your entire git repo](https://aider.chat/docs/ctags.html) and share it with GPT to help it better understand and modify large codebases. From d07d72c2d6642a57ddf4b277c853e18f3e677df0 Mon Sep 17 00:00:00 2001 From: paul-gauthier <69695708+paul-gauthier@users.noreply.github.com> Date: Wed, 31 May 2023 09:33:59 -0700 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7bdfffa14..28af7e5df 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ `aider` is a command-line chat tool that allows you to write and edit code with GPT-4. You can ask GPT to help you start a new project, or modify code in your existing git repo. -Aider makes it easy to git commit, diff & undo changes proposed by GPT. +Aider makes it easy to git commit, diff & undo changes proposed by GPT without copy/pasting. It also has features that [help GPT understand and modify larger codebases](https://aider.chat/docs/ctags.html). ![aider screencast](assets/screencast.svg)