diff --git a/README.md b/README.md index e6d05f67..c692009f 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -# YouTube Music -
+# YouTube Music + [![GitHub release](https://img.shields.io/github/release/th-ch/youtube-music.svg?style=for-the-badge&logo=youtube-music)](https://github.com/th-ch/youtube-music/releases/) [![GitHub license](https://img.shields.io/github/license/th-ch/youtube-music.svg?style=for-the-badge)](https://github.com/th-ch/youtube-music/blob/master/LICENSE) [![eslint code style](https://img.shields.io/badge/code_style-eslint-5ed9c7.svg?style=for-the-badge)](https://github.com/th-ch/youtube-music/blob/master/.eslintrc.js) @@ -35,69 +35,26 @@ Read this in other languages: [🇰🇷](./docs/readme/README-ko.md), [🇮🇸] |:---------------------------------------------------------------------------------------------------------:| |![Screenshot1](https://github.com/th-ch/youtube-music/assets/16558115/53efdf73-b8fa-4d7b-a235-b96b91ea77fc)| -## Translation +## Content -You can help with translation on [Hosted Weblate](https://hosted.weblate.org/projects/youtube-music/). - - - translation status - translation status 2 - - -## Download - -You can check out the [latest release](https://github.com/th-ch/youtube-music/releases/latest) to quickly find the -latest version. - -### Arch Linux - -Install the `youtube-music-bin` package from the AUR. For AUR installation instructions, take a look at -this [wiki page](https://wiki.archlinux.org/index.php/Arch_User_Repository#Installing_packages). - -### MacOS - -You can install the app using Homebrew (see the [cask definition](https://github.com/th-ch/homebrew-youtube-music)): - -```bash -brew install th-ch/youtube-music/youtube-music -``` - -If you install the app manually and get an error "is damaged and can’t be opened." when launching the app, run the following in the Terminal: - -```bash -xattr -cr /Applications/YouTube\ Music.app -``` - -### Windows - -You can use the [Scoop package manager](https://scoop.sh) to install the `youtube-music` package from -the [`extras` bucket](https://github.com/ScoopInstaller/Extras). - -```bash -scoop bucket add extras -scoop install extras/youtube-music -``` - -Alternately you can use [Winget](https://learn.microsoft.com/en-us/windows/package-manager/winget/), Windows 11s -official CLI package manager to install the `th-ch.YouTubeMusic` package. - -*Note: Microsoft Defender SmartScreen might block the installation since it is from an "unknown publisher". This is also -true for the manual installation when trying to run the executable(.exe) after a manual download here on github (same -file).* - -```bash -winget install th-ch.YouTubeMusic -``` - -#### How to install without a network connection? (in Windows) - -- Download the `*.nsis.7z` file for _your device architecture_ in [release page](https://github.com/th-ch/youtube-music/releases/latest). - - `x64` for 64-bit Windows - - `ia32` for 32-bit Windows - - `arm64` for ARM64 Windows -- Download installer in release page. (`*-Setup.exe`) -- Place them in the **same directory**. -- Run the installer. +- [Features](#features) +- [Available plugins](#available-plugins) +- [Translation](#translation) +- [Download](#download) + - [Arch Linux](#arch-linux) + - [MacOS](#macos) + - [Windows](#windows) + - [How to install without a network connection? (in Windows)](#how-to-install-without-a-network-connection-in-windows) +- [Themes](#themes) +- [Dev](#dev) +- [Build your own plugins](#build-your-own-plugins) + - [Creating a plugin](#creating-a-plugin) + - [Common use cases](#common-use-cases) +- [Build](#build) +- [Production Preview](#production-preview) +- [Tests](#tests) +- [License](#license) +- [FAQ](#faq) ## Features: @@ -202,6 +159,70 @@ winget install th-ch.YouTubeMusic - **Visualizer**: Different music visualizers +## Translation + +You can help with translation on [Hosted Weblate](https://hosted.weblate.org/projects/youtube-music/). + + + translation status + translation status 2 + + +## Download + +You can check out the [latest release](https://github.com/th-ch/youtube-music/releases/latest) to quickly find the +latest version. + +### Arch Linux + +Install the [`youtube-music-bin`](https://aur.archlinux.org/packages/youtube-music-bin) package from the AUR. For AUR installation instructions, take a look at +this [wiki page](https://wiki.archlinux.org/index.php/Arch_User_Repository#Installing_packages). + +### MacOS + +You can install the app using Homebrew (see the [cask definition](https://github.com/th-ch/homebrew-youtube-music)): + +```bash +brew install th-ch/youtube-music/youtube-music +``` + +If you install the app manually and get an error "is damaged and can’t be opened." when launching the app, run the following in the Terminal: + +```bash +xattr -cr /Applications/YouTube\ Music.app +``` + +### Windows + +You can use the [Scoop package manager](https://scoop.sh) to install the `youtube-music` package from +the [`extras` bucket](https://github.com/ScoopInstaller/Extras). + +```bash +scoop bucket add extras +scoop install extras/youtube-music +``` + +Alternately you can use [Winget](https://learn.microsoft.com/en-us/windows/package-manager/winget/), Windows 11s +official CLI package manager to install the `th-ch.YouTubeMusic` package. + +*Note: Microsoft Defender SmartScreen might block the installation since it is from an "unknown publisher". This is also +true for the manual installation when trying to run the executable(.exe) after a manual download here on github (same +file).* + +```bash +winget install th-ch.YouTubeMusic +``` + +#### How to install without a network connection? (in Windows) + +- Download the `*.nsis.7z` file for _your device architecture_ in [release page](https://github.com/th-ch/youtube-music/releases/latest). + - `x64` for 64-bit Windows + - `ia32` for 32-bit Windows + - `arm64` for ARM64 Windows +- Download installer in release page. (`*-Setup.exe`) +- Place them in the **same directory**. +- Run the installer. + ## Themes You can load CSS files to change the look of the application (Options > Visual Tweaks > Themes). @@ -368,7 +389,7 @@ Uses [Playwright](https://playwright.dev/) to test the app. MIT © [th-ch](https://github.com/th-ch/youtube-music) -## Most asked questions +## FAQ ### Why apps menu isn't showing up? diff --git a/docs/readme/README-is.md b/docs/readme/README-is.md index 3649a35e..4cea5a6d 100644 --- a/docs/readme/README-is.md +++ b/docs/readme/README-is.md @@ -1,7 +1,7 @@ -# YouTube Tónlist -
+# YouTube Tónlist + [![GitHub release](https://img.shields.io/github/release/th-ch/youtube-music.svg?style=for-the-badge&logo=youtube-music)](https://github.com/th-ch/youtube-music/releases/) [![GitHub license](https://img.shields.io/github/license/th-ch/youtube-music.svg?style=for-the-badge)](https://github.com/th-ch/youtube-music/blob/master/LICENSE) [![eslint code style](https://img.shields.io/badge/code_style-eslint-5ed9c7.svg?style=for-the-badge)](https://github.com/th-ch/youtube-music/blob/master/.eslintrc.js) @@ -33,69 +33,26 @@ |:---------------------------------------------------------------------------------------------------------:| |![Screenshot1](https://github.com/th-ch/youtube-music/assets/16558115/53efdf73-b8fa-4d7b-a235-b96b91ea77fc)| -## Þýðing +## Content -Þú getur aðstoðað við þýðingar á [Hosted Weblate](https://hosted.weblate.org/projects/youtube-music/). - - - translation status - translation status 2 - - -## Sækja - -Þú getur skoðað [nýjustu útgáfuna](https://github.com/th-ch/youtube-music/releases/latest) til að finna fljótt -nýjustu útgáfuna. - -### Arch Linux - -Settu upp `youtube-music-bin` pakkann frá AUR. Fyrir AUR uppsetningarleiðbeiningar skaltu skoða -þessa [wiki síðu](https://wiki.archlinux.org/index.php/Arch_User_Repository#Installing_packages). - -### MacOS - -Þú getur sett upp appið með því að nota Homebrew (sjá [cask skilgreiningu](https://github.com/th-ch/homebrew-youtube-music)) - -```bash -brew install th-ch/youtube-music/youtube-music -``` - -Ef þú setur upp forritið handvirkt og færð villu "er skemmd og ekki er hægt að opna það," þegar þú ræsir forritið skaltu keyra eftirfarandi í flugstöðinni: - -```bash -xattr -cr /Applications/YouTube\ Music.app -``` - -### Windows - -Þú getur notað [Scoop pakkastjórnun](https://scoop.sh) til að setja upp `youtube-music` pakkann frá -[`extras` fötuna](https://github.com/ScoopInstaller/Extras). - -```bash -scoop bucket add extras -scoop install extras/youtube-music -``` - -Að öðrum kosti geturðu notað [Winget](https://learn.microsoft.com/en-us/windows/package-manager/winget/), Windows 11s -opinber CLI pakkastjóri til að setja upp `th-ch.YouTubeMusic` pakkann. - -*Athugið: Microsoft Defender SmartScreen gæti lokað uppsetningunni þar sem hún er frá „óþekktum útgefanda“. Þetta er einnig -satt fyrir handvirka uppsetningu þegar reynt er að keyra executable(.exe) eftir handvirkt niðurhal hér á github (sama -skrá).* - -```bash -winget install th-ch.YouTubeMusic -``` - -#### Hvernig á að setja upp án nettengingar? (í Windows) - -- Sæktu `*.nsis.7z` skrána fyrir _arkitektúr tækisins þíns_ á [útgáfusíðu](https://github.com/th-ch/youtube-music/releases/latest). - - `x64` fyrir 64-bita Windows - - `ia32` fyrir 32-bita Windows - - `arm64` fyrir ARM64 Windows -- Sæktu uppsetningarforrit á útgáfusíðu. (`*-Setup.exe`) -- Settu þær í **sömu möppuna**. -- Keyrðu uppsetningarforritið. +- [Eiginleikar](#eiginleikar) +- [Tiltæk viðbætur](#tiltæk-viðbætur) +- [Þýðing](#þýðing) +- [Sækja](#sækja) + - [Arch Linux](#arch-linux) + - [MacOS](#macos) + - [Windows](#windows) + - [Hvernig á að setja upp án nettengingar? (í Windows)](#hvernig-á-að-setja-upp-án-nettengingar-í-windows) +- [Þemu](#þemu) +- [Þróun](#þróun) +- [Búðu til þín eigin viðbætur](#búðu-til-þín-eigin-viðbætur) + - [Er að búa til viðbót](#er-að-búa-til-viðbót) + - [Algeng notkunartilvik](#algeng-notkunartilvik) +- [Byggja](#byggja) +- [Framleiðsluforskoðun](#framleiðsluforskoðun) +- [Prófanir](#prófanir) +- [Leyfi](#leyfi) +- [Algengustu spurningar](#algengustu-spurningar) ## Eiginleikar: @@ -193,6 +150,70 @@ MP3 [beint úr viðmótinu](https://user-images.githubusercontent.com/61631665/1 - **Sjónrænir**: Mismunandi tónlist sjónrænir +## Þýðing + +Þú getur aðstoðað við þýðingar á [Hosted Weblate](https://hosted.weblate.org/projects/youtube-music/). + + + translation status + translation status 2 + + +## Sækja + +Þú getur skoðað [nýjustu útgáfuna](https://github.com/th-ch/youtube-music/releases/latest) til að finna fljótt +nýjustu útgáfuna. + +### Arch Linux + +Settu upp [`youtube-music-bin`](https://aur.archlinux.org/packages/youtube-music-bin) pakkann frá AUR. Fyrir AUR uppsetningarleiðbeiningar skaltu skoða +þessa [wiki síðu](https://wiki.archlinux.org/index.php/Arch_User_Repository#Installing_packages). + +### MacOS + +Þú getur sett upp appið með því að nota Homebrew (sjá [cask skilgreiningu](https://github.com/th-ch/homebrew-youtube-music)) + +```bash +brew install th-ch/youtube-music/youtube-music +``` + +Ef þú setur upp forritið handvirkt og færð villu "er skemmd og ekki er hægt að opna það," þegar þú ræsir forritið skaltu keyra eftirfarandi í flugstöðinni: + +```bash +xattr -cr /Applications/YouTube\ Music.app +``` + +### Windows + +Þú getur notað [Scoop pakkastjórnun](https://scoop.sh) til að setja upp `youtube-music` pakkann frá +[`extras` fötuna](https://github.com/ScoopInstaller/Extras). + +```bash +scoop bucket add extras +scoop install extras/youtube-music +``` + +Að öðrum kosti geturðu notað [Winget](https://learn.microsoft.com/en-us/windows/package-manager/winget/), Windows 11s +opinber CLI pakkastjóri til að setja upp `th-ch.YouTubeMusic` pakkann. + +*Athugið: Microsoft Defender SmartScreen gæti lokað uppsetningunni þar sem hún er frá „óþekktum útgefanda“. Þetta er einnig +satt fyrir handvirka uppsetningu þegar reynt er að keyra executable(.exe) eftir handvirkt niðurhal hér á github (sama +skrá).* + +```bash +winget install th-ch.YouTubeMusic +``` + +#### Hvernig á að setja upp án nettengingar? (í Windows) + +- Sæktu `*.nsis.7z` skrána fyrir _arkitektúr tækisins þíns_ á [útgáfusíðu](https://github.com/th-ch/youtube-music/releases/latest). + - `x64` fyrir 64-bita Windows + - `ia32` fyrir 32-bita Windows + - `arm64` fyrir ARM64 Windows +- Sæktu uppsetningarforrit á útgáfusíðu. (`*-Setup.exe`) +- Settu þær í **sömu möppuna**. +- Keyrðu uppsetningarforritið. + ## Þemu Þú getur hlaðið CSS skrám til að breyta útliti forritsins (Valkostir > Sjónræn klip > Þemu). diff --git a/docs/readme/README-ko.md b/docs/readme/README-ko.md index be971ec8..aaef632d 100644 --- a/docs/readme/README-ko.md +++ b/docs/readme/README-ko.md @@ -1,7 +1,7 @@ -# 유튜브 뮤직 (YouTube Music) -
+# 유튜브 뮤직 (YouTube Music) + [![GitHub release](https://img.shields.io/github/release/th-ch/youtube-music.svg?style=for-the-badge&logo=youtube-music)](https://github.com/th-ch/youtube-music/releases/) [![GitHub license](https://img.shields.io/github/license/th-ch/youtube-music.svg?style=for-the-badge)](https://github.com/th-ch/youtube-music/blob/master/LICENSE) [![eslint code style](https://img.shields.io/badge/code_style-eslint-5ed9c7.svg?style=for-the-badge)](https://github.com/th-ch/youtube-music/blob/master/.eslintrc.js) @@ -25,62 +25,26 @@ - 원래의 인터페이스를 유지하는 것을 목표로 하는 네이티브 디자인 및 느낌 - 맞춤 플러그인을 위한 프레임워크: 스타일, 콘텐츠, 기능 등 필요에 따라 유튜브 뮤직을 변경하고, 클릭 한 번으로 플러그인을 활성화/비활성화할 수 있습니다. -## 번역 +## Content -[Hosted Weblate](https://hosted.weblate.org/projects/youtube-music/)에서 번역을 도울 수 있습니다. - - - 번역 상태 - 번역 상태 2 - - -## 다운로드 - -[최신 릴리즈](https://github.com/th-ch/youtube-music/releases/latest)를 확인하여 최신 버전을 빠르게 찾을 수 있습니다. - -### Arch Linux - -AUR에서 `youtube-music-bin` 패키지를 설치합니다. AUR 설치 지침은 [이 위키 페이지](https://wiki.archlinux.org/index.php/Arch_User_Repository#Installing_packages)를 참조하세요. - -### MacOS - -Homebrew를 사용하여 앱을 설치할 수 있습니다: -```bash -brew install --cask https://raw.githubusercontent.com/th-ch/youtube-music/master/youtube-music.rb -``` - -(앱을 수동으로 설치하고) 앱을 실행할 때 `손상되었기 때문에 열 수 없습니다.`라는 오류가 발생하면 터미널에서 다음을 실행하세요: - -```bash -xattr -cr /Applications/YouTube\ Music.app -``` - -### Windows - -[Scoop 패키지 매니저](https://scoop.sh)를 사용하여 [`extras` 버킷](https://github.com/ScoopInstaller/Extras)에서 `youtube-music` 패키지를 설치할 수 있습니다. - -```bash -scoop bucket add extras -scoop install extras/youtube-music -``` - -또는 Windows 11의 공식 CLI 패키지 관리자인 [Winget](https://learn.microsoft.com/en-us/windows/package-manager/winget/)을 사용하여 `th-ch.YouTubeMusic` 패키지를 설치할 수 있습니다. - -*참고: "알 수 없는 게시자"의 파일이기 때문에 Microsoft Defender의 SmartScreen에서 설치를 차단할 수 있습니다. 이는 GitHub에서 동일 파일을 수동으로 다운로드한 후 실행 파일(.exe)을 실행하려고 할 때도 마찬가지로 발생합니다.* - -```bash -winget install th-ch.YouTubeMusic -``` - -#### (Windows에서) 네트워크에 연결하지 않고 설치하는 방법은 무엇인가요? - -- [릴리즈 페이지](https://github.com/th-ch/youtube-music/releases/latest)에서 _본인 기기 아키텍처_에 맞는 `*.nsis.7z` 파일을 다운로드하세요. - - `x64`는 64비트 Windows 용입니다. - - `ia32`는 32비트 Windows 용입니다. - - `arm64`는 ARM64 Windows 용입니다. -- 릴리즈 페이지에서 설치기를 다운로드하세요. (`*-Setup.exe`) -- 두 파일을 **동일한 위치**에 놓아주세요. -- 설치기를 실행하세요. +- [기능](#기능) +- [사용 가능한 플러그인](#사용-가능한-플러그인) +- [번역](#번역) +- [다운로드](#다운로드) + - [Arch Linux](#arch-linux) + - [MacOS](#macos) + - [Windows](#windows) + - [(Windows에서) 네트워크에 연결하지 않고 설치하는 방법은 무엇인가요?](#windows에서-네트워크에-연결하지-않고-설치하는-방법은-무엇인가요) +- [테마](#테마) +- [개발](#개발) +- [나만의 플러그인 만들기](#나만의-플러그인-만들기) + - [플러그인 만들기](#플러그인-만들기) + - [일반적인 사용 예](#일반적인-사용-예) +- [빌드](#빌드) +- [프로덕션 빌드 미리보기](#프로덕션-빌드-미리보기) +- [테스트](#테스트) +- [라이선스](#라이선스) +- [자주 묻는 질문](#자주-묻는-질문) ## 기능: @@ -156,6 +120,63 @@ winget install th-ch.YouTubeMusic - **비주얼라이저**: 플레이어에 시각화 도구 추가 +## 번역 + +[Hosted Weblate](https://hosted.weblate.org/projects/youtube-music/)에서 번역을 도울 수 있습니다. + + + 번역 상태 + 번역 상태 2 + + +## 다운로드 + +[최신 릴리즈](https://github.com/th-ch/youtube-music/releases/latest)를 확인하여 최신 버전을 빠르게 찾을 수 있습니다. + +### Arch Linux + +AUR에서 [`youtube-music-bin`](https://aur.archlinux.org/packages/youtube-music-bin) 패키지를 설치합니다. AUR 설치 지침은 [이 위키 페이지](https://wiki.archlinux.org/index.php/Arch_User_Repository#Installing_packages)를 참조하세요. + +### MacOS + +Homebrew를 사용하여 앱을 설치할 수 있습니다: +```bash +brew install --cask https://raw.githubusercontent.com/th-ch/youtube-music/master/youtube-music.rb +``` + +(앱을 수동으로 설치하고) 앱을 실행할 때 `손상되었기 때문에 열 수 없습니다.`라는 오류가 발생하면 터미널에서 다음을 실행하세요: + +```bash +xattr -cr /Applications/YouTube\ Music.app +``` + +### Windows + +[Scoop 패키지 매니저](https://scoop.sh)를 사용하여 [`extras` 버킷](https://github.com/ScoopInstaller/Extras)에서 `youtube-music` 패키지를 설치할 수 있습니다. + +```bash +scoop bucket add extras +scoop install extras/youtube-music +``` + +또는 Windows 11의 공식 CLI 패키지 관리자인 [Winget](https://learn.microsoft.com/en-us/windows/package-manager/winget/)을 사용하여 `th-ch.YouTubeMusic` 패키지를 설치할 수 있습니다. + +*참고: "알 수 없는 게시자"의 파일이기 때문에 Microsoft Defender의 SmartScreen에서 설치를 차단할 수 있습니다. 이는 GitHub에서 동일 파일을 수동으로 다운로드한 후 실행 파일(.exe)을 실행하려고 할 때도 마찬가지로 발생합니다.* + +```bash +winget install th-ch.YouTubeMusic +``` + +#### (Windows에서) 네트워크에 연결하지 않고 설치하는 방법은 무엇인가요? + +- [릴리즈 페이지](https://github.com/th-ch/youtube-music/releases/latest)에서 _본인 기기 아키텍처_에 맞는 `*.nsis.7z` 파일을 다운로드하세요. + - `x64`는 64비트 Windows 용입니다. + - `ia32`는 32비트 Windows 용입니다. + - `arm64`는 ARM64 Windows 용입니다. +- 릴리즈 페이지에서 설치기를 다운로드하세요. (`*-Setup.exe`) +- 두 파일을 **동일한 위치**에 놓아주세요. +- 설치기를 실행하세요. + ## 테마 CSS 파일을 로드하여 애플리케이션의 모양을 변경할 수 있습니다(설정 > 시각적 변경 > 테마).