Skip to content

Commit

Permalink
Update CHANGELOG and README for release 0.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
rbreu committed Jul 10, 2021
1 parent 6656982 commit 47bf495
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 4 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
0.1.0 - 2021-07-10
==================

First release!
19 changes: 16 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,23 @@ BeeRef lets you quickly arrange your reference images and view them while you cr
:target: https://codecov.io/gh/rbreu/beeref


Installation via Python & pip
-----------------------------
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.

Follow further releases via the `atom feed <https://github.com/rbreu/beeref/releases.atom>`_.

**Linux users** who want to have BeeRef appear in the app menu, save the desktop file from the `release section <https://github.com/rbreu/beeref/releases>`_ in ``~/.local/share/applications`` and adjust the path names in the file to match the location of your BeeRef installation.


Development Version
~~~~~~~~~~~~~~~~~~~

At the moment, you need to have a working Python 3 environment to install BeeRef. Run the following command to install the development version::
To get the current delevopment version, you need to have a working Python 3 environment. Run the following command to install the development version::

pip install git+https://github.com/rbreu/beeref.git

Expand Down
2 changes: 1 addition & 1 deletion beeref.desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Terminal=false
Exec=/home/yourname/path/to/beeref/git/dist/BeeRef-0.1.0/BeeRef-0.1.0
Type=Application
Icon=/home/yourname/path/to/BeeRef-0.1.0/beeref/assets/logo.png
Name[en_US]=Beeref
Name[en_US]=BeeRef

MimeType=application/x-beeref;
Categories=Qt;KDE;Graphics;
Expand Down

0 comments on commit 47bf495

Please sign in to comment.