diff --git a/.gitignore b/.gitignore index 91939da..4e17ede 100644 --- a/.gitignore +++ b/.gitignore @@ -129,3 +129,8 @@ dmypy.json # Pyre type checker .pyre/ + +# github pages +Gemfile.lock +_site +.bundle \ No newline at end of file diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index b3d0065..f30c9c3 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -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 `_ 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 "" diff --git a/README.rst b/README.rst index 874ecb8..b38b72c 100644 --- a/README.rst +++ b/README.rst @@ -5,7 +5,7 @@ BeeRef — A Simple Reference Image Viewer -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 `_ 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 `_. 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 `_. Extract the zip file. Inside the extracted folder, you will find a BeeRef executable. Follow further releases via the `atom feed `_. @@ -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.