From 8ebf7cd13154c78983700b3c29c76f68b290398c Mon Sep 17 00:00:00 2001 From: Paul Gauthier Date: Mon, 10 Jun 2024 17:29:41 -0700 Subject: [PATCH] Updated quick start --- README.md | 14 +------------- website/_includes/get-started.md | 16 ++++++++++++++++ website/docs/install.md | 14 +------------- website/index.md | 14 +------------- 4 files changed, 19 insertions(+), 39 deletions(-) create mode 100644 website/_includes/get-started.md diff --git a/README.md b/README.md index 944485e83..9f932f331 100644 --- a/README.md +++ b/README.md @@ -25,19 +25,7 @@ and can [connect to almost any LLM](https://aider.chat/docs/llms.html). ## Getting started -You can get started quickly like this: - -``` -$ pip install aider-chat - -# To work with GPT-4o -$ export OPENAI_API_KEY=your-key-goes-here -$ aider - -# To work with Claude 3 Opus: -$ export ANTHROPIC_API_KEY=your-key-goes-here -$ aider --opus -``` +{% include get-started.md %} **See the [installation instructions](https://aider.chat/docs/install.html) diff --git a/website/_includes/get-started.md b/website/_includes/get-started.md new file mode 100644 index 000000000..498d310dc --- /dev/null +++ b/website/_includes/get-started.md @@ -0,0 +1,16 @@ +You can get started quickly like this: + +``` +$ 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 +``` diff --git a/website/docs/install.md b/website/docs/install.md index 0bfacd4de..58cc3957b 100644 --- a/website/docs/install.md +++ b/website/docs/install.md @@ -7,19 +7,7 @@ description: How to install and get started pair programming with aider. # Quick start -You can get started quickly like this: - -``` -$ pip install aider-chat - -# To work with GPT-4o -$ export OPENAI_API_KEY=your-key-goes-here -$ aider - -# To work with Claude 3 Opus: -$ export ANTHROPIC_API_KEY=your-key-goes-here -$ aider --opus -``` +{% include get-started.md %} Or see the [full installation instructions](/docs/install/install.html) diff --git a/website/index.md b/website/index.md index 40b97c33c..0f0865f68 100644 --- a/website/index.md +++ b/website/index.md @@ -33,19 +33,7 @@ and can [connect to almost any LLM](https://aider.chat/docs/llms.html). ## Getting started -You can get started quickly like this: - -``` -$ pip install aider-chat - -# To work with GPT-4o -$ export OPENAI_API_KEY=your-key-goes-here -$ aider - -# To work with Claude 3 Opus: -$ export ANTHROPIC_API_KEY=your-key-goes-here -$ aider --opus -``` +{% include get-started.md %} **See the [installation instructions](https://aider.chat/docs/install.html)