summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.rst
diff options
context:
space:
mode:
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r--CONTRIBUTING.rst8
1 files changed, 4 insertions, 4 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 495b4ec..4e7b1bd 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -8,16 +8,16 @@ with a subject that starts with `[PATCH lirc]` for patches and `[lirc]` otherwis
Getting Up & Running
--------------------
-This project uses `Poetry <https://python-poetry.org>`_ for the build system and dependency management.
+This project uses `uv <https://docs.astral.sh/uv/>`_ for the build system and dependency management.
To get started, you will want that installed on your system.
-Once you've installed ``Poetry``, you can install the dependencies, this package, and go into the
+Once you've installed ``uv``, you can install the dependencies, this package, and go into the
virtual environment.
.. code-block:: bash
- $ poetry install
- $ poetry shell
+ $ uv sync --all-groups
+ $ source .venv/bin/activate
From inside the virtual environment, we can work with the package and easily run the tasks for
this project such as ``task test`` and ``task lint`` that are in the ``pyproject.toml`` file.