From 5a6d285e6a262b515da55c564d86756f28d5c117 Mon Sep 17 00:00:00 2001 From: James Smith Date: Thu, 26 Dec 2024 14:03:54 -0800 Subject: [PATCH] Minor edits to CONTRIBUTING.md --- CONTRIBUTING.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2beb8e5..731829c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,12 +20,15 @@ First off, thanks for taking the time to contribute! ### Using `uv` -aiovantage uses [uv](https://docs.astral.sh/uv/) to run scripts, manages virtual environments, create reproducible builds, and publish packages. Check out the [uv installation guide](https://docs.astral.sh/uv/getting-started/installation/) to get started. +aiovantage uses [uv](https://docs.astral.sh/uv/) to run scripts, manage virtual environments, create reproducible builds, and publish packages. Check out the [uv installation guide](https://docs.astral.sh/uv/getting-started/installation/) to get started. To set up your development environment, run the following commands: ```bash +# Create a virtual environment uv venv + +# Install development dependencies uv pip install -e ".[dev]" ``` @@ -40,8 +43,13 @@ uv run python examples/dump_system.py hostname If you'd prefer to manage your own python environment, you can install the development dependencies manually. ```bash +# Create a virtual environment python -m venv .venv + +# Activate the virtual environment source .venv/bin/activate + +# Install development dependencies pip install -e ".[dev]" ```