From 35e5accac9c6994b9735bc7ecb1d679e2b70bdc5 Mon Sep 17 00:00:00 2001
From: Peter Sobolewski <76622105+psobolewskiPhD@users.noreply.github.com>
Date: Mon, 27 Nov 2023 03:28:07 -0500
Subject: [PATCH] [Maint] Improve contribution in README and remove pyqt5 from
 [dev] install dependency (#188)

* remove pyqt5 from [dev]
* Update README.md
* Clarify tests and Qt backend in README
---
 README.md | 36 +++++++++++++++++++++++++-----------
 setup.cfg |  1 -
 2 files changed, 25 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 6dc14eb..5edf801 100644
--- a/README.md
+++ b/README.md
@@ -87,21 +87,35 @@ use of the plugin follow.
 
 ## Contributing
 
-Contributions are very welcome and a detailed contributing guide is coming soon. 
-
-Tests are run with `pytest`.
-
-We use [`pre-commit`](https://pre-commit.com) to sort imports with
-[`isort`](https://github.com/timothycrosley/isort), format code with
-[`black`](https://github.com/psf/black), and lint with
-[`flake8`](https://github.com/PyCQA/flake8) automatically prior to each commit.
-To minmize test errors when submitting pull requests, please install `pre-commit`
-in your environment as follows:
+Contributions are very welcome and a detailed contributing guide is coming soon.
+In the meantime, clone this repository and install it in editable mode using `pip`. 
+We recommend using a virtual environment, for example `conda`.
+> [!IMPORTANT]
+> Ensure you have a suitable Qt backend for napari! We recommend `PyQt5`.
+> For more information, see the napari [Qt backend installation guide](https://napari.org/stable/tutorials/fundamentals/installation.html#choosing-a-different-qt-backend)
 
 ```sh
-pre-commit install
+conda create -n nap-anim python=3.10
+conda activate nap-anim
+pip install -e ".[dev]" PyQt5
+
 ```
 
+Tests are run with `pytest`.
+You can make sure your `[dev]` installation is working properly by running
+`pytest .` from within the repository.
+
+> [!NOTE]
+> We use [`pre-commit`](https://pre-commit.com) to sort imports with
+> [`isort`](https://github.com/timothycrosley/isort), format code with
+> [`black`](https://github.com/psf/black), and lint with
+> [`flake8`](https://github.com/PyCQA/flake8) automatically prior to each commit.
+> To minmize test errors when submitting pull requests, please install `pre-commit`
+> in your environment as follows:
+> ```sh
+> pre-commit install
+> ```
+
 ## License
 
 Distributed under the terms of the [BSD-3] license,
diff --git a/setup.cfg b/setup.cfg
index 027bd5a..3f2e739 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -50,7 +50,6 @@ dev =
     flake8
     isort
     check-manifest
-    PyQt5>=5.12.3,!=5.15.0
     %(testing)s