zach
/
RA.Aid
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

installation docs

This commit is contained in:
AI Christianson 2025-02-14 16:20:02 -05:00
parent 35cd07c324
commit dbf3d83523
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/docs/quickstarts/installation.md
View File

@ -3,6 +3,9 @@ import TabItem from '@theme/TabItem';
# Installation
<Tabs groupId="install-method">
<TabItem value="uv" label="UV" default>
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
```
</TabItem>
<TabItem value="pip" label="pip">
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.
:::
</TabItem>
<TabItem value="macos" label="macOS">
Install RA.Aid using Homebrew:
```bash
brew tap ai-christianson/homebrew-ra-aid
brew install ra-aid
```
</TabItem>
</Tabs>
Once installed, see the [Recommended Configuration](recommended) to set up RA.Aid with the recommended settings.