Updated instructions

This commit is contained in:
Rebecca Breu 2021-03-28 14:28:48 +02:00
parent fc806cdf8f
commit c7e7dff3a6
2 changed files with 9 additions and 3 deletions

View file

@ -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``.

View file

@ -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
-----------------------------