Docs: Add uv section

UV is now supported as first-party in tabbyAPI's start script, so
add a dedicated section to it and recommend over miniconda.

Signed-off-by: kingbri <8082010+kingbri1@users.noreply.github.com>
This commit is contained in:
kingbri 2025-08-19 22:54:27 -04:00
parent 1f4186512e
commit bd3aa5bb04

View file

@ -2,10 +2,10 @@
To get started, make sure you have the following installed on your system:
- [Python 3.x](https://www.python.org/downloads/release/python-3117/) (preferably 3.11) with pip
- [Python 3.x](https://www.python.org/downloads/release/python-31210/) (preferably 3.12) with pip
- Do NOT install python from the Microsoft store! This will cause issues with pip.
- Alternatively, you can use miniconda or uv if it's present on your system.
- Alternatively, you can use uv (preferred) or miniconda if it's present on your system.
> [!NOTE]
@ -133,6 +133,18 @@ These are short-form instructions for other methods that users can use to instal
> [!WARNING]
> Using methods other than venv may not play nice with startup scripts. Using these methods indicates that you're an advanced user and know what you're doing.
### Uv
> [!NOTE]
> Uv is the preferred way to handle python. It's recommended to use it over conda and its derivatives.
1. Install [Uv](https://docs.astral.sh/uv/getting-started/installation/#installation-methods) from astral's website
2. Continue installation steps from:
1. [For Beginners](#for-beginners) - Step 3. The start scripts detect if uv is installed and runs the appropriate commands.
2. [For Advanced Users](#For-advanced-users) - Step 3
### Conda
1. Install [Miniconda3](https://docs.conda.io/projects/miniconda/en/latest/miniconda-other-installer-links.html) with python 3.11 as your base python