From 4aa46c2714970dc3cce3748e25515da58fa10cc8 Mon Sep 17 00:00:00 2001 From: Paul Gauthier Date: Tue, 9 May 2023 11:52:32 -0700 Subject: [PATCH] updated readme --- README.md | 28 +++++++++++++++++++--------- 1 file changed, 19 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index f2dc8a6be..9e804a0a5 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,14 @@ It can make changes, improvements, and bug fixes to your code with the assistanc ## Features -* Chat with GPT about your code -* Make changes, improvements, and bug fixes to your code -* Automatically commit changes to a Git repository -* Colorized output for better readability -* Supports multiple source code files +* Chat with GPT about your code by specifying a set of source files to discuss +* Request changes, improvements, and bug fixes to your code +* Aider will apply the edits suggested by GPT. +* Aider will automatically commit each change to a git repo with a sensible commit message, providing safety, edit history and easy undo with normal git tools +* Live, colorized, human friendly output +* Can make coordinated changes across multiple source files +* Readline style chat input history, with autocompletion of tokens found in source files being discussed + ## Installation 1. Clone the repository. @@ -26,8 +29,15 @@ aider ... Replace ``, ``, etc., with the paths to the source code files you want to work on. -You can also use additional command-line options to customize the behavior of the tool. For more information, run: +You can also use additional command-line options to customize the behavior of the tool. For more information, run `aider --help`. Many defaults can be set with `.env` or environment variables, see the help output. + +## Limitations + +Aider basically requires GPT-4 for the main chat functions. +You can invoke it with `aider -3` to try using gpt-3.5-turbo, but it will almost certainly fail to function correctly. +GPT-3.5 is unable to follow directions and generate code changes in a stable, parsable format. + +Aider also can only edit code that can fit in the context window. +For GPT-4 that is 8k tokens. +If you have access to gpt-4-32k, I would be curious to hear you experiences using it with aider. -``` -python -m aider.main --help -```