aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAeliton G. Silva2026-01-12 22:39:55 -0300
committerAeliton G. Silva2026-01-13 04:22:25 -0300
commitf975144f25d34f97329b2d4e52891061573cea08 (patch)
tree226fe223b31af6f217b1dd413629ab2cf26964d4 /README.md
parentb8703752ffc7768b0275897b3c2a869ff41504e5 (diff)
Use pyproject.toml + uv_build
This replaces setup.py by a modern pyproject.toml using uv_build backend. Dependencies are being also managed by uv, so to install dependencies and run the project one can execute: ``` uv sync uv run pytest # optional python -m avp ``` To build the both source and binary (wheel) distribution package run: ``` uv build ``` Uv can be installed with `pip install uv`. The directory structure has been changed to reflect best practices. - src/* -> src/avp/ - src/tests -> ../tests
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/README.md b/README.md
index d867651..8d1108b 100644
--- a/README.md
+++ b/README.md
@@ -25,8 +25,10 @@ The program works on **Linux**, **macOS**, and **Windows**. If you encounter pro
- Install system dependencies: `sudo apt install ffmpeg`
- Make a virtual environment: `python -m venv env`
- Activate it: `source env/bin/activate`
-- Install program: `pip install pyqt6 pillow numpy .`
-- Run the program with `avp` from terminal
+- Install Python dependencies: `pip install uv`
+- Install this program: `uv sync` in this directory
+- Run the program with `python -m avp` from terminal
+- Optional: Unit tests can be run with `uv run pytest`
## Installation on Windows