From c7e7dff3a6740a0affd6cdb3146e1d61cefba83f Mon Sep 17 00:00:00 2001 From: Rebecca Breu Date: Sun, 28 Mar 2021 14:28:48 +0200 Subject: [PATCH] Updated instructions --- CONTRIBUTING.rst | 6 +++--- README.rst | 6 ++++++ 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 399177f..1715173 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -6,11 +6,11 @@ BeeRef is written in Python and PyQt6. Clone the repository and install beeref and its dependencies:: git clone https://github.com/rbreu/beeref.git - pip install -e beeref + cd beeref + pip install -e . Install additional development requirements:: - cd beeref pip install -r requirements/dev.txt Run unittests with:: @@ -23,7 +23,7 @@ Run codechecks with:: Run unittests with coverage report:: - coverage run --source=beeref -m pytest; + coverage run --source=beeref -m pytest coverage html If your browser doesn't open automatically, view ``htmlcov/index.html``. diff --git a/README.rst b/README.rst index 53a75fc..c92b754 100644 --- a/README.rst +++ b/README.rst @@ -23,6 +23,12 @@ At the moment, you need to have a working Python 3 environment to install BeeRef Then run ``beeref`` or ``beeref filename.bee``. +If there are issues starting the applictaion, run it with the environment varibale ``QT_DEBUG_PLUGINS`` set to 1, for example from a Linux shell:: + + QT_DEBUG_PLUGINS=1 beeref + +This should tell you whether you need to install any additional libraries, most likely regarding opengl. + Regarding the bee file format -----------------------------