diff --git a/README.md b/README.md index 087dd065c85c980013a5b928fd41bfde1362f020..56644b821c1fa866bfd6fd54320d16e17893b834 100644 --- a/README.md +++ b/README.md @@ -25,12 +25,19 @@ from vipscore_common.data_utils import * ### Unit tests The tests are located in the `tests` folder, and we're using [Pytest](https://docs.pytest.org/) +Prerequisite: To test, use a venv, install this package in it by running: +``` bash +(venv) $ python -m pip install -e . +``` + To run the unit tests, move to the root folder of the project, and execute: ``` bash pytest -v ``` + + ### Using bumpver For developers: When you want to publish a new version, use ``` bash