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

Update README and CONTRIBUTING

Browse source
This commit is contained in:
Rebecca Breu 2021-07-12 19:59:44 +02:00
parent 18a60f08fa
commit 2bf3f95fde
3 changed files with 24 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.gitignore vendored
View file

@ -129,3 +129,8 @@ dmypy.json
# Pyre type checker
.pyre/
# github pages
Gemfile.lock
_site
.bundle

5
CONTRIBUTING.rst
View file

@ -37,3 +37,8 @@ For debugging options, run::
The Python version badge in the README is generated with pybadges::
python -m pybadges --left-text=Python --right-text="3.6 | 3.7 | 3.8 | 3.9" > images/python_version_badge.svg
The `website <https://rbreu.github.io/beeref/>`_ is hosted via Github pages from the gh-pages branch. You can run it locally if you have Ruby and bundler installed::
bundle install
bundle exec jekyll serve --baseurl ""

17
README.rst
View file

@ -5,7 +5,7 @@ BeeRef — A Simple Reference Image Viewer
<img align="left" width="100" height="100" src="https://raw.githubusercontent.com/rbreu/beeref/main/beeref/assets/logo.png">
BeeRef lets you quickly arrange your reference images and view them while you create. Its minimal interface is designed not to get in the way of your creative process.
`BeeRef <https://rbreu.github.io/beeref/>`_ lets you quickly arrange your reference images and view them while you create. Its minimal interface is designed not to get in the way of your creative process.
|python-version| |github-ci-flake8| |github-ci-pytest| |codecov|
@ -30,7 +30,7 @@ Installation
Stable Release
~~~~~~~~~~~~~~
Get the zip file for your operating systom from the `latest release <https://github.com/rbreu/beeref/releases>`_. Extract the zip file. Inside the extracted folder, you will find a BeeRef executable.
Get the zip file for your operating system (Windows, Linux, macOS) from the `latest release <https://github.com/rbreu/beeref/releases>`_. Extract the zip file. Inside the extracted folder, you will find a BeeRef executable.
Follow further releases via the `atom feed <https://github.com/rbreu/beeref/releases.atom>`_.
@ -53,8 +53,19 @@ If there are issues starting the application, run it with the environment variba
This should tell you whether you need to install any additional libraries.
Features
--------
* Move, scale, rotate and flip images
* Mass-scale images to the same width, height or size
* Mass-arrange images vertically, horizontally or for optimal usage of space
* Enable alaways-on-top-mode and disable the title bar to let the BeeRef window unobtrusively float above your art program:
.. image:: https://github.com/rbreu/beeref/blob/main/images/screenshot.png
Regarding the bee file format
-----------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Currently, all images are embedded into the bee file as png files. While png is a lossless format, it may also produce larger file sizes than compressed jpg files, so bee files may become bigger than the imported images on their own. More embedding options are to come later.