diff --git a/README.md b/README.md index 880f28c96..957f062f6 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ + + # 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).

## Getting started + You can get started quickly like this: ``` @@ -40,6 +47,7 @@ $ aider $ export ANTHROPIC_API_KEY=your-key-goes-here $ aider --opus ``` + **See the [installation instructions](https://aider.chat/docs/install.html) diff --git a/scripts/update-docs.sh b/scripts/update-docs.sh index 756a61c69..ce40f2d44 100755 --- a/scripts/update-docs.sh +++ b/scripts/update-docs.sh @@ -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 \ diff --git a/website/index.md b/website/index.md index 0f0865f68..3895c4433 100644 --- a/website/index.md +++ b/website/index.md @@ -4,9 +4,17 @@ nav_order: 1 --- + + # 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).

## Getting started + +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 +``` + **See the [installation instructions](https://aider.chat/docs/install.html)