Skip to content

Commit

Permalink
Merge pull request #80 from fiersik/master
Browse files Browse the repository at this point in the history
Обновил README
  • Loading branch information
Rirusha authored Mar 23, 2024
2 parents 45b8db0 + 69f81fd commit 3cbdafb
Showing 1 changed file with 67 additions and 51 deletions.
118 changes: 67 additions & 51 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
</h1>

<p align="center">
GTK4/Adwaita приложение, которое позволит вам использовать Я.Музыку на Linux.
GTK4/Adwaita приложение, которое позволит вам использовать Я.Музыку на Linux.
</p>

<br/>
Expand All @@ -14,64 +14,84 @@
<a href="https://stopthemingmy.app">
<img src="https://stopthemingmy.app/badge.svg"/>
</a>
<br>
<a href="https://t.me/CassetteGNOME_Devlog">
<img alt="tg" src="https://img.shields.io/badge/Telegtam-chanel-blue?style=flat&logo=telegram&label=%20&labelColor=blue">
</a>
<br>
<a href="https://t.me/CassetteGNOME_Discussion">
<img alt="tg" src="https://img.shields.io/badge/Telegtam-chat-blue?style=flat&logo=telegram&label=%20&labelColor=blue">
</a>
</p>

<p align="center">
<a href="https://flathub.org/apps/details/io.github.Rirusha.Cassette">
<img width="200" src="https://flathub.org/assets/badges/flathub-badge-en.png" alt="Download on Flathub">
<img width="200" src="https://flathub.org/assets/badges/flathub-badge-en.png" alt="Download on Flathub">
</a>
</p>

<p align="center">
<img src="data/images/first.png" alt="Screenshot"/>
<img src="data/images/first.png" alt="Screenshot"/>
</p>


## План основных версий
* [ ] 0.2: Моя волна
* [ ] 0.3: Альбомы и исполнители
* [ ] 0.4: Поиск по сервису
* [ ] 0.5: Подкасты и книги

Все запланированные фичи можете [посмотреть в бэклоге](https://github.com/users/Rirusha/projects/2)
Все запланированные фичи можете [посмотреть в бэклоге](https://github.com/users/Rirusha/projects/2) \
Описание ближайших релизов доступно [здесь](https://github.com/Rirusha/Cassette/milestones)

## Установка
### Через репозиторий …

## Установка из репозитория

Приложение Cassette доступно здесь:

[![Packaging status](https://repology.org/badge/vertical-allrepos/cassette.svg)](https://repology.org/project/cassette/versions)
#### ALT Sisyphus

### ALT Sisyphus
```
sudo apt-get install cassette
```

### … или используя flatpak

## Установка c помощью Flatpak

Вы можете скачать по [ссылке](https://flathub.org/apps/details/io.github.Rirusha.Cassette) или используя терминал

```
flatpak install io.github.Rirusha.Cassette
```

### Nightly версия
Есть возможность установки nightly версии, которая обновляется каждые сутки.

__ВНИМАНИЕ!: эта версия нестабильна.__
## Nightly версия

Для работы требуется установить org.gnome.Platform//master из gnome-nightly репозитория. Подключение репозитория и установка пакета, необходимого для запуска devel версии описаны в разделе [Для разработчиков](https://github.com/Rirusha/Cassette?tab=readme-ov-file#для-разработчиков).
> [!WARNING]
> Данная версия каждые сутки собирается и обновляется из dev ветки приложения, поэтому может оказаться нестабильной
Установка приложения происходит из nightly репозитория, который также нужно подключить:
#### Подключаем репозиторий gnome-nightly и устанавливаем GNOME Platform:
```shell
flatpak remote-add --if-not-exists gnome-nightly https://nightly.gnome.org/gnome-nightly.flatpakrepo
flatpak install gnome-nightly org.gnome.Platform//master
```

#### Подключаем Nightly репозиторий и устанавливаем приложение:
```shell
flatpak remote-add --if-not-exists cassette-nightly https://rirusha.github.io/Cassette/index.flatpakrepo
flatpak install io.github.Rirusha.Cassette-Devel
flatpak install cassette-nightly io.github.Rirusha.Cassette-Devel
```

Для удаления репозитория нужно выполнить:
#### Для удаления репозитория нужно выполнить:
```
flatpak remote-delete cassette-nightly
```

### Сборка из исходного кода

Зависимости:
## Сборка из исходного кода

#### Зависимости:
* ```gtk4```, version >= 4.12
* ```libadwaita-1```, version >= 1.4
* ```libsoup-3.0```
Expand All @@ -84,7 +104,7 @@ flatpak remote-delete cassette-nightly
* ```webkitgtk-6.0```
* ```gio-2.0```

Утилиты для сборки:
#### Утилиты для сборки:
* ```meson```
* ```ninja```
* ```cmake```
Expand All @@ -94,71 +114,67 @@ flatpak remote-delete cassette-nightly
* ```pkg```
* ```appstream-utils```

Сборка:
### Сборка:
```
meson setup builddir
ninja -C builddir test
```

Установка:
### Установка:
```
sudo ninja -C builddir install
```

Удаление:
### Удаление:
```
sudo ninja -C builddir uninstall
```

## Для разработчиков
Все изменения должны нужно вносить в dev-* ветки. Коммиты в master и deploy ветки будут отклонены.

Для возможности запуска devel версии понадобиться подключить [gnome-nightly](https://wiki.gnome.org/Apps/Nightly) репозиторий:
> [!NOTE]
> Все изменения необходимо вносить в `dev-*` ветки. Коммиты в `master` и `devel-slice` будут отклонены.
### Использование Visual Studio Code
Репозиторий имеет рекомендуемые расширения для проверки и запуска приложения с gdb.

### Зависимости

#### репозиторий [gnome-nightly](https://wiki.gnome.org/Apps/Nightly):
```
flatpak remote-add --if-not-exists gnome-nightly https://nightly.gnome.org/gnome-nightly.flatpakrepo
```

И установить:
* org.gnome.Platform//master
#### Для запуска
`org.gnome.Platform//master`
```
flatpak install org.gnome.Platform//master
```

Для сборки devel версии нужно установить:
* org.gnome.Sdk//master
* org.freedesktop.Sdk.Extension.vala-nightly//23.08beta
#### Для сборки
`org.gnome.Sdk//master` \
`org.freedesktop.Sdk.Extension.vala-nightly//23.08beta`
```
flatpak install org.gnome.Sdk//master org.freedesktop.Sdk.Extension.vala-nightly//23.08beta
```

Для удаления репозитория нужно выполнить выполнить:
```
flatpak remote-delete gnome-nightly
```

#### … использующих Visual Studio Code
Репозиторий имеет рекоммендуемые расширения и сценарии проверки линта и запуска приложения с gdb.

## Полезные ссылки
* Телеграм-канал с девлогами: https://t.me/CassetteGNOME_Devlog
* Чат с обсуждением новых фичей и проблем: https://t.me/CassetteGNOME_Discussion
* Сообщить об ошибке: https://github.com/Rirusha/Cassette/issues

## Поддержка
Вы можете поддержать несколькими способами:
* Создать ишью с проблемой или предложением по улучшению;
* Отправить pull request с фиксом или добавлением функционала;
* Поддержать рублём (Просьба указывать в "Сообщении получателю" свой никнейм при отправлении через Тинькофф):
<p>
<a href="https://www.tinkoff.ru/cf/21GCxLuFuE9">
- Создать ишью с проблемой или предложением по улучшению;
- Отправить pull request с фиксом или добавлением функционала;
- Поддержать рублём (Просьба указывать в "Сообщении получателю" свой никнейм при отправлении через Тинькофф):

<p>
<a href="https://www.tinkoff.ru/cf/21GCxLuFuE9">
<img height="36" src="https://github.com/Rirusha/Cassette/assets/95986183/87496207-aa1c-40fc-a511-57bac188bc72" alt="Tinkoff">
</a>
</p>
<p>
<a href="https://boosty.to/rirusha/donate">
</a>
</p>
<p>
<a href="https://boosty.to/rirusha/donate">
<img height="36" src="https://github.com/Rirusha/Cassette/assets/95986183/313ee5af-d374-4f95-af62-9445d1c27347" alt="boosty.to">
</a>
</p>
</a>
</p>

## Благодарность
Спасибо [MarshalX](https://github.com/MarshalX). Библиотека [yandex-music-api](https://github.com/MarshalX/yandex-music-api) была использована в качестве документации к api.
Expand Down

0 comments on commit 3cbdafb

Please sign in to comment.