diff --git a/CHANGELOG.rst b/CHANGELOG.rst new file mode 100644 index 0000000..abf63c0 --- /dev/null +++ b/CHANGELOG.rst @@ -0,0 +1,4 @@ +0.1.0 - 2021-07-10 +================== + +First release! diff --git a/README.rst b/README.rst index 2e6c53d..874ecb8 100644 --- a/README.rst +++ b/README.rst @@ -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 +------------ -At the moment, you need to have a working Python 3 environment to install BeeRef. Run the following command to install the development version:: +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. + +Follow further releases via the `atom feed `_. + +**Linux users** who want to have BeeRef appear in the app menu, save the desktop file from the `release section `_ in ``~/.local/share/applications`` and adjust the path names in the file to match the location of your BeeRef installation. + + +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 diff --git a/beeref.desktop b/beeref.desktop index 6cbdd79..5366b44 100644 --- a/beeref.desktop +++ b/beeref.desktop @@ -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;