From 68b9581188f3a53f5354bcd065a38c315a13d28a Mon Sep 17 00:00:00 2001 From: Paul Gauthier Date: Tue, 9 May 2023 12:02:49 -0700 Subject: [PATCH] updated readme --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index ad45e26ac..e69a2b6be 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,26 @@ # Aider -Aider is a command-line tool that allows you to chat with GPT about your code. -It can make changes, improvements, and bug fixes to your code with the assistance of GPT. +Aider is a command-line tool that allows you to chat with GPT-4 about your code. +It can make changes, improvements, and bug fixes to your code. Each change is automatically committed to git with a sensible commit message. ## Features -* Chat with GPT about your code by specifying a set of source files to discuss -* Request changes, improvements, and bug fixes to your code +* 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 -* Use Control-C to safely interrupt GPT if it isn't providing a useful response -* Aider will notice if asked to discuss files with uncommitted changes and offer to commit them before proceeding +* 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. +* Aider can make coordinated code changes across multiple source files. +* Live, colorized, human friendly output. +* Readline style chat input history, with autocompletion of tokens found in source files being discussed (via `prompt_toolkit`) +* Use Control-C to safely interrupt GPT if it isn't providing a useful response. +* Provide a multiline chat message by entering `{` alone on a line. End the message with `}` alone on a line. +* Aider will notice if asked to discuss files with uncommitted changes and offer to commit them before proceeding. ## Installation -1. Clone the repository. -2. Install the required packages using `pip install -r requirements.txt`. -3. Set up your OpenAI API key as an environment variable `OPENAI_API_KEY` or by including it in a `.env` file. +1. Install the package: `pip install git+https://github.com/paul-gauthier/aider.git` +2. Set up your OpenAI API key as an environment variable `OPENAI_API_KEY` or by including it in a `.env` file. ## Usage