prehistoric-systems/beeref: BeeRef Reference Image Viewer

mirror of https://github.com/rbreu/beeref.git synced 2026-03-11 08:54:28 +00:00

BeeRef Reference Image Viewer

Find a file

Rebecca Breu ef086f1468 Fix small load/save issues		2021-03-26 20:22:33 +01:00
.github/workflows	See if switching to python 3.7 fixes pytest CI	2021-03-24 22:34:28 +01:00
beeref	Fix small load/save issues	2021-03-26 20:22:33 +01:00
images	Added screenshot	2021-03-25 19:55:00 +01:00
requirements	Add undo/redo for everything	2021-03-25 16:44:39 +01:00
tests	Fix small load/save issues	2021-03-26 20:22:33 +01:00
.gitignore	First commit	2021-03-22 21:32:33 +01:00
CONTRIBUTING.rst	Fix markup in CONTRIBUTING	2021-03-25 16:45:55 +01:00
LICENSE	Initial commit	2021-03-22 21:09:12 +01:00
README.rst	Add screenshot to README	2021-03-25 19:56:29 +01:00
setup.py	Code cleanup	2021-03-24 09:54:14 +01:00

README.rst

BeeRef — A Simple Reference Image Viewer
========================================

View your references while you art!

.. image:: https://github.com/rbreu/beeref/blob/main/images/screenshot.jpg

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