From dbf3d83523f55aa922c15899bbf917ea27f8bb29 Mon Sep 17 00:00:00 2001 From: AI Christianson Date: Fri, 14 Feb 2025 16:20:02 -0500 Subject: [PATCH] installation docs --- docs/docs/quickstarts/installation.md | 29 +++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/docs/docs/quickstarts/installation.md b/docs/docs/quickstarts/installation.md index bc84efd..314f540 100644 --- a/docs/docs/quickstarts/installation.md +++ b/docs/docs/quickstarts/installation.md @@ -3,6 +3,9 @@ import TabItem from '@theme/TabItem'; # Installation + + + Create a new Python 3.12 virtual environment and install RA.Aid: First install [uv](https://docs.astral.sh/uv/getting-started/installation/), then: @@ -32,4 +35,30 @@ source .venv/bin/activate uv pip install ra-aid ``` + + + +Install RA.Aid using pip: + +```bash +pip install ra-aid +``` + +:::note +If you're using Python 3.13 or newer, we recommend using the UV installation method instead due to compatibility issues with newer Python versions. +::: + + + + +Install RA.Aid using Homebrew: + +```bash +brew tap ai-christianson/homebrew-ra-aid +brew install ra-aid +``` + + + + Once installed, see the [Recommended Configuration](recommended) to set up RA.Aid with the recommended settings.