prehistoric-systems/beeref
1
0
Fork 0
mirror of https://github.com/rbreu/beeref.git synced 2026-03-11 08:54:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
BeeRef Reference Image Viewer
11 commits 4 branches 8 tags 3.5 MiB
Python 100%
Find a file
Rebecca Breu 268d00af32 Code cleanup
2021-03-24 09:54:14 +01:00
beeref Code cleanup 2021-03-24 09:54:14 +01:00
requirements Add setup.py file and structure Python files correctly 2021-03-23 16:31:55 +01:00
tests Code cleanup 2021-03-24 09:54:14 +01:00
.gitignore First commit 2021-03-22 21:32:33 +01:00
LICENSE Initial commit 2021-03-22 21:09:12 +01:00
README.rst Fix README markup 2021-03-23 16:37:02 +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!


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.

Clone the repository and install beeref and its dependencies::

  git clone https://github.com/rbreu/beeref.git
  pip install -e beeref

Install additional development requirements::

  cd beeref
  pip install -r requirements/dev.txt

Run unittests with::

  pytest .

Run codechecks with::

  flake8 .