aider/examples/README.md
Paul Gauthier 1e7c39a73b copy
2023-05-13 12:24:28 -07:00

36 lines
2.4 KiB
Markdown

# Using `aider` chat to code with GPT-4
Below are some example transcripts that show how you can chat with
the `aider` command line tool
to generate and edit code with GPT-4.
Some things to note in the transcripts:
#### > The user's chat messages are bold and shown on a prompt line. They contain they user's change requests, clarifications, etc.
Responses from GPT-4 are in a plain font, and often include colorized code blocks that specify edits to the code.
> Output from the aider tool is shown in a blockquote
In the `aider` output, you will see it:
- Adding certain source files to the chat (sometimes at the suggestion of GPT-4, always with user permission).
- Applying the edits proposed by GPT-4 to the source files.
- Committing those changes to git with a senisble commit message.
There are a varity of example coding chat sessions included,
accomplishing both greenfield generation of new code as well as simple and complex edits to larger codebases:
* [Hello World Flask App](hello-world-flask.md): This example demonstrates how to create a simple Flask app with various endpoints, such as adding two numbers and calculating the Fibonacci sequence.
* [2048 Game Modification](2048-game.md): This example demonstrates how to explore and modify an open-source javascript 2048 game codebase, including adding randomness to the scoring system.
* [Pong Game with Pygame](pong.md): This example demonstrates how to create a simple Pong game using the Pygame library, with customizations for paddle size and color, and ball speed adjustments.
* [Complex Multi-file Change with Debugging](complex-change.md): This example demonstrates a complex code change involving multiple source files and debugging with the help of `aider`.
* [Semantic Search & Replace](semantic-search-replace.md): This example showcases `aider` performing semantic search and replace operations in code, dealing with various formatting and semantic differences in the function calls that it updates.
* [CSS Exercise: Animation Dropdown Menu](css-exercises.md): This example demonstrates how to complete a CSS exercise involving adding animation to a dropdown menu, creating a bounce illusion when the dropdown expands close to its final end state.
* [Automatically Update Docs](update-docs.md): This example demonstrates how to use `aider` to automatically update documentation based on the latest version of the main() function in the code.