mirror of
https://github.com/Aider-AI/aider.git
synced 2025-05-29 00:35:00 +00:00
use cog to include get-started in readme
This commit is contained in:
parent
d65e16c4df
commit
3532bd7758
3 changed files with 40 additions and 2 deletions
|
@ -1,4 +1,6 @@
|
||||||
|
|
||||||
|
<!-- Edit README.md, not index.md -->
|
||||||
|
|
||||||
# Aider is AI pair programming in your terminal
|
# Aider is AI pair programming in your terminal
|
||||||
|
|
||||||
Aider lets you pair program with LLMs,
|
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>
|
</p>
|
||||||
|
|
||||||
## Getting started
|
## 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:
|
You can get started quickly like this:
|
||||||
|
|
||||||
```
|
```
|
||||||
|
@ -40,6 +47,7 @@ $ aider
|
||||||
$ export ANTHROPIC_API_KEY=your-key-goes-here
|
$ export ANTHROPIC_API_KEY=your-key-goes-here
|
||||||
$ aider --opus
|
$ aider --opus
|
||||||
```
|
```
|
||||||
|
<!--[[[end]]]-->
|
||||||
|
|
||||||
**See the
|
**See the
|
||||||
[installation instructions](https://aider.chat/docs/install.html)
|
[installation instructions](https://aider.chat/docs/install.html)
|
||||||
|
|
|
@ -9,7 +9,9 @@ else
|
||||||
ARG=$1
|
ARG=$1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
# README.md before index.md, because index.md uses cog to include README.md
|
||||||
cog $ARG \
|
cog $ARG \
|
||||||
|
README.md \
|
||||||
website/index.md \
|
website/index.md \
|
||||||
website/docs/commands.md \
|
website/docs/commands.md \
|
||||||
website/docs/languages.md \
|
website/docs/languages.md \
|
||||||
|
|
|
@ -4,9 +4,17 @@ nav_order: 1
|
||||||
---
|
---
|
||||||
|
|
||||||
<!--[[[cog
|
<!--[[[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 is AI pair programming in your terminal
|
||||||
|
|
||||||
Aider lets you pair program with LLMs,
|
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>
|
</p>
|
||||||
|
|
||||||
## Getting started
|
## 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
|
**See the
|
||||||
[installation instructions](https://aider.chat/docs/install.html)
|
[installation instructions](https://aider.chat/docs/install.html)
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue