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

use cog to include get-started in readme

Browse source
This commit is contained in:
Paul Gauthier 2024-06-11 18:51:36 -07:00
parent d65e16c4df
commit 3532bd7758
3 changed files with 40 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -1,4 +1,6 @@
<!-- Edit README.md, not index.md -->
# Aider is AI pair programming in your terminal
Aider lets you pair program with LLMs,
@ -24,6 +26,11 @@ and can [connect to almost any LLM](https://aider.chat/docs/llms.html).
</p>
## Getting started
<!--[[[cog
# We can't do this here: {% include get-started.md %}
# Because this page is rendered by GitHub as the repo README
cog.out(open("website/_includes/get-started.md").read())
]]]-->
You can get started quickly like this:
```
@ -40,6 +47,7 @@ $ aider
$ export ANTHROPIC_API_KEY=your-key-goes-here
$ aider --opus
```
<!--[[[end]]]-->
**See the
[installation instructions](https://aider.chat/docs/install.html)

2
scripts/update-docs.sh
View file

@ -9,7 +9,9 @@ else
ARG=$1
fi
# README.md before index.md, because index.md uses cog to include README.md
cog $ARG \
README.md \
website/index.md \
website/docs/commands.md \
website/docs/languages.md \

32
website/index.md
View file

@ -4,9 +4,17 @@ nav_order: 1
---
<!--[[[cog
cog.out(open("README.md").read())
# This page is a copy of README.md, adding the front matter above.
# Remove any cog markup before inserting the README text.
text = open("README.md").read()
text = text.replace('['*3 + 'cog', ' NOOP ')
text = text.replace('['*3 + 'end', ' NOOP ')
text = text.replace(']'*3, '')
cog.out(text)
]]]-->
<!-- Edit README.md, not index.md -->
# Aider is AI pair programming in your terminal
Aider lets you pair program with LLMs,
@ -32,8 +40,28 @@ and can [connect to almost any LLM](https://aider.chat/docs/llms.html).
</p>
## Getting started
<!-- NOOP
# We can't do this here: {% include get-started.md %}
# Because this page is rendered by GitHub as the repo README
cog.out(open("website/_includes/get-started.md").read())
-->
You can get started quickly like this:
{% include get-started.md %}
```
$ pip install aider-chat
# Change directory into a git repo
$ cd /to/your/git/repo
# Work with GPT-4o on your repo
$ export OPENAI_API_KEY=your-key-goes-here
$ aider
# Or, work with Claude 3 Opus on your repo
$ export ANTHROPIC_API_KEY=your-key-goes-here
$ aider --opus
```
<!-- NOOP -->
**See the
[installation instructions](https://aider.chat/docs/install.html)