beeref/README.rst
2021-03-25 16:44:39 +01:00

29 lines
1,008 B
ReStructuredText

BeeRef — A Simple Reference Image Viewer
========================================
View your references while you art!
|github-ci-flake8| |github-ci-pytest|
.. |github-ci-flake8| image:: https://github.com/rbreu/beeref/actions/workflows/flake8.yml/badge.svg
:target: https://github.com/rbreu/beeref/actions/workflows/flake8.yml
.. |github-ci-pytest| image:: https://github.com/rbreu/beeref/actions/workflows/pytest.yml/badge.svg
:target: https://github.com/rbreu/beeref/actions/workflows/pytest.yml
Installation via Python & pip
-----------------------------
At the moment, you need to have a working Python 3 environment to install BeeRef. Run the following command to install the development version::
pip install git+https://github.com/rbreu/beeref.git
Then run ``beeref`` or ``beeref filename.bee``.
Notes for developers
--------------------
BeeRef is written in Python and PyQt6. For more info, see `CONTRIBUTING.rst <https://github.com/rbreu/beeref/blob/main/CONTRIBUTING.rst>`_.