Skip to content

Commit

Permalink
chore: updated info files
Browse files Browse the repository at this point in the history
  • Loading branch information
Dzheremi2 committed Jan 5, 2025
1 parent e37fa2e commit cc5a0b5
Show file tree
Hide file tree
Showing 4 changed files with 113 additions and 89 deletions.
35 changes: 35 additions & 0 deletions Chronograph.doap
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<?xml version="1.0" encoding="UTF-8"?>
<Project xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"
xmlns:foaf="http://xmlns.com/foaf/0.1/"
xmlns:gnome="http://api.gnome.org/doap-extensions#"
xmlns="http://usefulinc.com/ns/doap#">

<name>Chronograph</name>
<shortdesc xml:lang="en">Sync lyrics of your loved songs</shortdesc>
<description xml:lang="en">
This app helps you to contribute to the large database of synced lyrics with beautiful GTK4 and LibAdwaita interface. It supports music in ogg, flac, mp3 and wav formats
</description>

<homepage rdf:resource="https://github.com/Dzheremi2/Chronograph/" />
<download-page rdf:resource="https://github.com/Dzheremi2/Chronograph/" />
<bug-database rdf:resource="https://github.com/Dzheremi2/Chronograph/issues" />

<programming-language>Python</programming-language>
<platform>GTK 4</platform>
<platform>Libadwaita</platform>

<maintaner>
<foaf:Person>
<foaf:name>Dzheremi</foaf:name>
<foaf:mbox rdf:resource="mailto:chichvarov1315@gmail.com" />\
<foaf:account>
<foaf:OnlineAccaunt>
<foaf:accountServiceHomepage rdf:resource="https://github.com"/>
<foaf:accountName>Dzheremi2</foaf:accountName>
</foaf:OnlineAccaunt>
</foaf:account>
</foaf:Person>
</maintaner>

</Project>
88 changes: 29 additions & 59 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,95 +1,65 @@
>[!IMPORTANT]
>App is currently in reworking status. You can see rework progress on `full-rewrite` branch of this repo
>
>There's also CI available for `full-rewrite` branch, so if you want to test out rewrite builds and help me to fix bugs, you can use CI bundles, available from Artifacts block.
<div align="center">

<img src="data/icons/hicolor/scalable/apps/io.github.dzheremi2.Chronograph.svg" width="128" height="128">

# LRCMake
# Chronograph
[flathub-url]: https://flathub.org/apps/io.github.dzheremi2.lrcmake-gtk
[installs-img]: https://img.shields.io/flathub/downloads/io.github.dzheremi2.lrcmake-gtk?style=for-the-badge&color=gree&logo=flathub

![GitHub Release](https://img.shields.io/github/v/release/Dzheremi2/LRCMake-GTK?style=for-the-badge&color=000B3C&logo=github)
![GitHub Release](https://img.shields.io/github/v/release/Dzheremi2/Chronograph?style=for-the-badge&color=000B3C&logo=github)
<img alt="Flathub Version" src="https://img.shields.io/flathub/v/io.github.dzheremi2.lrcmake-gtk?style=for-the-badge&logo=flathub&color=lightblue">
[![Installs][installs-img]][flathub-url]
![Weblate project translated](https://img.shields.io/weblate/progress/lrcmake?style=for-the-badge&logo=weblate&logoColor=white&logoSize=auto&color=magenta&cacheSeconds=600)
<img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/Dzheremi2/LRCMake-GTK/.github%2Fworkflows%2Fci.yml?style=for-the-badge&logo=github">
![GitHub License](https://img.shields.io/github/license/Dzheremi2/LRCMake-GTK?style=for-the-badge&color=C25D00)
<img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/Dzheremi2/Chronograph/.github%2Fworkflows%2Fci.yml?style=for-the-badge&logo=github">
![GitHub License](https://img.shields.io/github/license/Dzheremi2/Chronograph?style=for-the-badge&color=C25D00)

![Screenshot](docs/screenshots/lib.png)
![Screenshot](docs/screenshots/libB.png)

</div>

### 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).
### About Chronograph
Chronograph is the app for syncing song lyrics by timestamps.
Chronograph supports `.ogg`, `.flac`, `.mp3` and `.wav` media formats
You can import lyrics from Clipboard, File or from [LRClib](https://lrclib.net) and export your lyrics to these destinations

### Installation
<a href='https://flathub.org/apps/io.github.dzheremi2.lrcmake-gtk'>
<img width='240' alt='Get it on Flathub' src='https://flathub.org/api/badge?svg&locale=en'/>
</a>

You can download app either on [Flathub](https://flathub.org/apps/io.github.dzheremi2.lrcmake-gtk) or by downloading and installing bundle from [latest release](https://github.com/Dzheremi2/LRCMake-GTK/releases/latest)
You can download app either on [Flathub](https://flathub.org/apps/io.github.dzheremi2.lrcmake-gtk) or by downloading and installing bundle from [latest release](https://github.com/Dzheremi2/Chronograph/releases/latest)

##### *Devel builds*

If you want to download a devel build, you can do it by downloading it from [Github Actions](https://github.com/Dzheremi2/LRCMake-GTK/actions) from Artifacts section
If you want to download a devel build, you can do it by downloading it from [Github Actions](https://github.com/Dzheremi2/Chronograph/actions) from Artifacts section

>[!CAUTION]
>Devel builds may be unstable or don't even launch. Use it at your own risk
### Translation
You can help project to be internationalized using [Hosted Weblate](https://hosted.weblate.org/projects/lrcmake/lrcmake/)
You can help project to be internationalized using [Hosted Weblate](https://hosted.weblate.org/projects/lrcmake/chronograph/)

##### Translation status

[![Состояние перевода](https://hosted.weblate.org/widget/lrcmake/lrcmake/287x66-black.png)](https://hosted.weblate.org/engage/lrcmake/)
[![Translate state](https://hosted.weblate.org/widget/lrcmake/lrcmake/multi-auto.svg)](https://hosted.weblate.org/engage/lrcmake/)
[![Состояние перевода](https://hosted.weblate.org/widget/lrcmake/chronograph/287x66-black.png)](https://hosted.weblate.org/engage/lrcmake/)
[![Translate state](https://hosted.weblate.org/widget/lrcmake/chronograph/multi-auto.svg)](https://hosted.weblate.org/engage/lrcmake/)

### Plans
You can see future plans on Projects page of this repo on [LRCMake roadmap.](https://github.com/users/Dzheremi2/projects/2)

If you have an idea or you know a bug, please, open an issue with you idea/bug and it will be added to roadmap.

### 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 io.github.dzheremi2.lrcmake-gtk org.gnome.Sdk org.gnome.Platform 47
```
```shell
flatpak-builder --ccache --force-clean --disable-updates --download-only --state-dir={repofolder}/.flatpak/flatpak-builder --stop-at=python3-modules {repofolder}/.flatpak/repo {repofolder}/io.github.dzheremi2.lrcmake-gtk.json
```
```shell
flatpak-builder --ccache --force-clean --disable-updates --disable-download --build-only --keep-build-dirs --state-dir={repofolder}/.flatpak/flatpak-builder --stop-at=python3-modules {repofolder}/.flatpak/repo {repofolder}/io.github.dzheremi2.lrcmake-gtk.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 io.github.dzheremi2.lrcmake-gtk.flatpak io.github.dzheremi2.lrcmake-gtk
```
You can see future plans on Projects page of this repo on [Chronograph roadmap.](https://github.com/users/Dzheremi2/projects/2)

If you have an idea or you know a bug, please, open an [issue](https://github.com/Dzheremi2/Chronograph/issues) with you idea/bug and it will be added to roadmap.

### Code of Conduct
The project follows the [GNOME Code of Conduct.](https://conduct.gnome.org)


### Screenshots
<div align="center">

![](docs/screenshots/libW.png)
![](docs/screenshots/syncB.png)
![](docs/screenshots/syncW.png)
![](docs/screenshots/lrclibB.png)
![](docs/screenshots/lrclibW.png)

![](docs/screenshots/syncing.png)
![](docs/screenshots/file_info.png)
![](docs/screenshots/lib_light.png)
![](docs/screenshots/syncing_light.png)
![](docs/screenshots/file_info_light.png)
</div>
2 changes: 1 addition & 1 deletion data/gtk/window.blp
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Adw.Dialog quick_edit_dialog {
[top]
Adw.HeaderBar {
Label {
label: _("Quick Edit");
label: _("Quick Editor");

styles ["title-3"]
}
Expand Down
77 changes: 48 additions & 29 deletions data/io.github.dzheremi2.Chronograph.metainfo.xml.in
Original file line number Diff line number Diff line change
Expand Up @@ -7,58 +7,78 @@
<name>Chronograph</name>
<summary>Sync lyrics of your loved songs</summary>
<description>
<p>This app helps you to contribute to the large database of synced lyrics with beautiful GTK4 and LibAdwaita interface.</p>
<p>This app helps you to contribute to the large database of synced lyrics with beautiful GTK4 and LibAdwaita interface. It supports music in ogg, flac, mp3 and wav formats</p>
</description>

<developer id="tld.vendor">
<developer id="com.github">
<name translate="no">Dzheremi</name>
</developer>

<url type="homepage">https://github.com/Dzheremi2/LRCMake-GTK/</url>
<url type="vcs-browser">https://github.com/Dzheremi2/LRCMake-GTK/</url>
<url type="bugtracker">https://github.com/Dzheremi2/LRCMake-GTK/issues</url>
<url type="translate">https://hosted.weblate.org/projects/lrcmake/lrcmake/</url>
<url type="help">https://github.com/Dzheremi2/LRCMake-GTK/discussions</url>
<url type="contact">https://github.com/Dzheremi2/LRCMake-GTK/issues</url>
<url type="contribute">https://github.com/Dzheremi2/LRCMake-GTK/pulls</url>
<url type="homepage">https://github.com/Dzheremi2/Chronograph/</url>
<url type="vcs-browser">https://github.com/Dzheremi2/Chronograph/</url>
<url type="bugtracker">https://github.com/Dzheremi2/Chronograph/issues</url>
<url type="translate">https://hosted.weblate.org/projects/lrcmake/chronograph/</url>
<url type="help">https://github.com/Dzheremi2/Chronograph/discussions</url>
<url type="contact">https://github.com/Dzheremi2/Chronograph/issues</url>
<url type="contribute">https://github.com/Dzheremi2/Chronograph/pulls</url>

<translation type="gettext">Chronograph</translation>
<launchable type="desktop-id">io.github.dzheremi2.Chronograph.desktop</launchable>
<launchable type="desktop-id">@APP_ID@.desktop</launchable>
<content_rating type="oars-1.1" />

<branding>
<color type="primary" scheme_preference="light">#74c69d</color>
<color type="primary" scheme_preference="dark">#1b4332</color>
</branding>
<supports>
<control>keyboard</control>
<control>touch</control>
<control>pointing</control>
</supports>
<requires>
<display_lenth compare="ge">360</display_lenth>
</requires>

<screenshots>
<screenshot type="default" xml:lang="en">
<image>https://raw.githubusercontent.com/Dzheremi2/LRCMake-GTK/refs/heads/master/docs/screenshots/lib.png</image>
<caption>Library view</caption>
<screenshot type="default" xml:lang="ru">
<image>https://raw.githubusercontent.com/Dzheremi2/Chronograph/refs/heads/master/docs/screenshots/libW.png</image>
<caption>Library</caption>
</screenshot>
<screenshot xml:lang="en">
<image>https://raw.githubusercontent.com/Dzheremi2/LRCMake-GTK/refs/heads/master/docs/screenshots/syncing.png</image>
<caption>Lyrics syncing page view</caption>
<screenshot xml:lang="ru">
<image>https://raw.githubusercontent.com/Dzheremi2/Chronograph/refs/heads/master/docs/screenshots/syncW.png</image>
<caption>Lyrics syncing page</caption>
</screenshot>
<screenshot xml:lang="en">
<image>https://raw.githubusercontent.com/Dzheremi2/LRCMake-GTK/refs/heads/master/docs/screenshots/file_info.png</image>
<caption>Dialog with opened file details view</caption>
<screenshot xml:lang="ru">
<image>https://raw.githubusercontent.com/Dzheremi2/Chronograph/refs/heads/master/docs/screenshots/lrclibW.png</image>
<caption>LRClib import dialog</caption>
</screenshot>
<screenshot xml:lang="en">
<image>https://raw.githubusercontent.com/Dzheremi2/LRCMake-GTK/2df0ef7fec9291f5877dc4e74ab05537d2d2b8d9/docs/screenshots/lib_light.png</image>
<caption>Library view light</caption>
<screenshot xml:lang="ru">
<image>https://raw.githubusercontent.com/Dzheremi2/Chronograph/refs/heads/master/docs/screenshots/libB.png</image>
<caption>Library</caption>
</screenshot>
<screenshot xml:lang="en">
<image>https://raw.githubusercontent.com/Dzheremi2/LRCMake-GTK/2df0ef7fec9291f5877dc4e74ab05537d2d2b8d9/docs/screenshots/syncing_light.png</image>
<caption>Lyrics syncing page view light</caption>
<screenshot xml:lang="ru">
<image>https://raw.githubusercontent.com/Dzheremi2/Chronograph/refs/heads/master/docs/screenshots/syncB.png</image>
<caption>Lyrics syncing page</caption>
</screenshot>
<screenshot xml:lang="en">
<image>https://raw.githubusercontent.com/Dzheremi2/LRCMake-GTK/2df0ef7fec9291f5877dc4e74ab05537d2d2b8d9/docs/screenshots/file_info_light.png</image>
<caption>Dialog with opened file details view light</caption>
<screenshot xml:lang="ru">
<image>https://raw.githubusercontent.com/Dzheremi2/Chronograph/refs/heads/master/docs/screenshots/lrclibB.png</image>
<caption>LRClib import dialog</caption>
</screenshot>
</screenshots>

<releases>
<release version="2.0" date="2025-01-06">
<description translate="no">
<p>Full app rewrite for better performance and flexibility</p>
<ul>
<li>App has been renamed to Chronograph</li>
<li>New icon</li>
<li>App is now adaptive for different display sizes</li>
<li>Added session saving</li>
<li>Added ability to pin current directory</li>
</ul>
</description>
</release>
<release version="1.2.1" date="2024-12-10">
<description translate="no">
<p>Important hotfix of publishing functionality</p>
Expand Down Expand Up @@ -150,5 +170,4 @@
</description>
</release>
</releases>

</component>

0 comments on commit cc5a0b5

Please sign in to comment.