clarify-uv-init

This commit is contained in:
Mendon Kissling 2025-10-02 13:00:23 -04:00
parent 1750836509
commit 2b89b9cdae

View file

@ -31,15 +31,14 @@ The `.whl` file is currently available as an internal download during public pre
The OpenRAG wheel installs the Terminal User Interface (TUI) for running and managing OpenRAG. The OpenRAG wheel installs the Terminal User Interface (TUI) for running and managing OpenRAG.
1. Create a new project with a virtual environment using `uv`. 1. Create a new project with a virtual environment using `uv init`.
This creates and activates a virtual environment for your project.
```bash ```bash
uv init YOUR_PROJECT_NAME uv init YOUR_PROJECT_NAME
cd YOUR_PROJECT_NAME cd YOUR_PROJECT_NAME
``` ```
The terminal prompt won't change like it would when using `venv`, but the `uv` commands will use the project's virtual environment. You won't see a `(venv)` prompt change, but `uv` commands automatically use the project's virtual environment.
For more information on virtual environments, see the [uv documentation](https://docs.astral.sh/uv/pip/environments). For more information on virtual environments, see the [uv documentation](https://docs.astral.sh/uv/pip/environments).
2. Add the local OpenRAG wheel to your project's virtual environment. 2. Add the local OpenRAG wheel to your project's virtual environment.