From 89ac431f1dede1ad3c0eee280b22813ee2d7861a Mon Sep 17 00:00:00 2001 From: Paul Gauthier Date: Sat, 13 May 2023 14:45:28 -0700 Subject: [PATCH] copy --- examples/README.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/examples/README.md b/examples/README.md index 3528764ac..29b79cc66 100644 --- a/examples/README.md +++ b/examples/README.md @@ -10,7 +10,24 @@ There are a few things worth taking note of: - Code edits proposed by GPT-4 are automatically applied to the source files by `aider`. - After applying the edits, `aider` will commit them to git with a senisble commit message. -## Example chat transcripts +## Transcript formatting + +> Output from the aider tool is shown in a blockquote like this. + +#### > The user's chat messages are bold and shown on a prompt line like this. They contain they user's change requests, clarifications, etc. + +Responses from GPT-4 are in a plain font like this, and often include colorized code blocks that specify edits to the code. +Here's a sample edit that switches from printing a blank line to printing "hello world" in the file `hello.py`: + +```python +hello.py +<<<<<<< ORIGINAL +print() +======= +print("Hello world!") +>>>>>>> UPDATED + +```## Example chat transcripts 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: @@ -29,20 +46,3 @@ accomplishing both greenfield generation of new code as well as simple and compl * [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. -## Transcript formatting - -> Output from the aider tool is shown in a blockquote - -#### > 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. -Here's a sample edit that switches from printing a blank line to printing "hello world": - -```python -hello.py -<<<<<<< ORIGINAL -print() -======= -print("Hello world!") ->>>>>>> UPDATED -``` \ No newline at end of file