dearwolf/aider
1
0
Fork 0
mirror of https://github.com/Aider-AI/aider.git synced 2025-06-01 10:14:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Update README.md with installation and usage instructions for Aider tool.

Browse source 
# Context:
USER: Use ORIGINAL/UPDATE format to provide a README.md for this tool
ASSISTANT: Here's a basic README.md for the Aider tool using the ORIGINAL/UPDATED format:

```
README.md
<<<<<<< ORIGINAL

=======
# Aider

Aider is a command-line tool that allows you to chat with GPT about your code. It helps you to make changes, improvements, and bug fixes to your code with the assistance of GPT.

## 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`.

## Usage

Run the Aider tool by executing the following command:

```
python -m aider.main <file1> <file2> ...
```

Replace `<file1>`, `<file2>`, 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:

```
python -m aider.main --help
```
>>>>>>> UPDATED
```

This will create a README.md file with a brief description, installation, and usage instructions for the Aider tool.
This commit is contained in:
Paul Gauthier 2023-05-09 11:40:27 -07:00
parent c1e4f0d7e7
commit eb1372236d
1 changed files with 25 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -0,0 +1,25 @@
# Aider
Aider is a command-line tool that allows you to chat with GPT about your code. It helps you to make changes, improvements, and bug fixes to your code with the assistance of GPT.
## 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`.
## Usage
Run the Aider tool by executing the following command:
```
python -m aider.main <file1> <file2> ...
```
Replace `<file1>`, `<file2>`, 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:
```
python -m aider.main --help
```