Skip to content

Commit

Permalink
Minor edits to CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
loopj committed Dec 26, 2024
1 parent 8b0b413 commit 5a6d285
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]"
```

Expand All @@ -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]"
```

Expand Down

0 comments on commit 5a6d285

Please sign in to comment.