docs: added README.md

README.md

@@ -1,3 +1,53 @@
-# lrcmake
+# LRCMake
 
-A description of this project.
+![GitHub Release](https://img.shields.io/github/v/release/Dzheremi2/LRCMake-GTK)
+![GitHub License](https://img.shields.io/github/license/Dzheremi2/LRCMake-GTK)
+
+
+![Screenshot](docs/screenshots/lib.png)
+
+### What is LRCMake
+LRCMake is the app written in python using GTK4 and LibAdwaita. LRCMake is used for syncing lyrics for future contributing it to various resources, especially [LRCLIB](https://lrclib.net).
+
+LRCMake support exporting lyrics to clipboard and direct publishing to [LRCLIB](https://lrclib.net).
+
+### Installation
+
+Download `.flatpak` file from the [latest release](https://github.com/Dzheremi2/LRCMake-GTK/releases/latest) and install it.
+
+### Building
+
+#### Dependencies
+You'll need to install `flatpak-builder` package and `org.gnome.Platform` flatpak runtime of version `47`
+
+#### Building
+
+Execute this commands one-by-one:
+*Replace ***{repofolder}*** with your path to repository directory*
+
+```shell
+flatpak build-init {repofolder}/.flatpak/repo com.github.dzheremi.lrcmake org.gnome.Sdk org.gnome.Platform 47
+```
+```shell
+flatpak-builder --ccache --force-clean --disable-updates --download-only --state-dir=/home/dzheremi/Projects/LRCMake/.flatpak/flatpak-builder --stop-at=python3-modules {repofolder}/.flatpak/repo {repofolder}/com.github.dzheremi.lrcmake.json
+```
+```shell
+flatpak-builder --ccache --force-clean --disable-updates --disable-download --build-only --keep-build-dirs --state-dir=/home/dzheremi/Projects/LRCMake/.flatpak/flatpak-builder --stop-at=python3-modules {repofolder}/.flatpak/repo {repofolder}/com.github.dzheremi.lrcmake.json
+```
+```shell
+cp -r {repofolder}/.flatpak/repo {repofolder}/.flatpak/finalized-repo
+```
+```shell
+flatpak build-finish --share=network --share=ipc --socket=fallback-x11 --device=dri --socket=wayland --socket=pulseaudio --command=lrcmake {repofolder}/.flatpak/finalized-repo
+```
+```shell
+flatpak build-export {repofolder}/.flatpak/ostree-repo {repofolder}/.flatpak/finalized-repo
+```
+```shell
+flatpak build-bundle {repofolder}/.flatpak/ostree-repo com.github.dzheremi.lrcmake.flatpak com.github.dzheremi.lrcmake
+```
+
+### Screenshots
+
+![](docs/screenshots/syncing.png)
+![](docs/screenshots/file_info.png)

data/com.github.dzheremi.lrcmake.metainfo.xml.in

@@ -43,18 +43,22 @@
   <!-- <branding>
     <color type="primary" scheme_preference="light">#ff00ff</color>
     <color type="primary" scheme_preference="dark">#993d3d</color>
-  </branding>
+  </branding> -->
 
   <screenshots>
     <screenshot type="default">
-      <image>https://example.org/example1.png</image>
-      <caption>A caption</caption>
+      <image>https://github.com/Dzheremi2/LRCMake-GTK/blob/master/docs/screenshots/lib.png?raw=true</image>
+      <caption>Library view</caption>
     </screenshot>
     <screenshot>
-      <image>https://example.org/example2.png</image>
-      <caption>A caption</caption>
+      <image>https://github.com/Dzheremi2/LRCMake-GTK/blob/master/docs/screenshots/syncing.png?raw=true</image>
+      <caption>Lyrics syncing page view</caption>
     </screenshot>
-  </screenshots> -->
+    <screenshot>
+      <image>https://github.com/Dzheremi2/LRCMake-GTK/blob/master/docs/screenshots/file_info.png?raw=true</image>
+      <caption>Dialog with opened file details view</caption>
+    </screenshot>
+  </screenshots>
 
   <releases>
     <release version="0.1" date="2024-11-15">

src/main.py

@@ -62,7 +62,7 @@ def show_about_dialog(self, *args):
             license="GNU GPL V3 OR LATER",
             license_type=Gtk.License.GPL_3_0,
             website="https://github.com/Dzheremi2/LRCMake-GTK",
-            version=self.version + " (commit_id)",
+            version=self.version + " (bfa3c2c)",
             designers=["Dzheremi"]
         )
         dialog.present(self.win)