Update README

toasterofbread · Feb 20, 2024 · 13be4a9 · 13be4a9
1 parent 5ee4cd5
commit 13be4a9
Show file tree

Hide file tree

Showing 6 changed files with 50 additions and 37 deletions.
diff --git a/README.md b/README.md
@@ -17,15 +17,6 @@ A YouTube Music client with a focus on customisation of colours and song metadat
 <br>
 <br>
 
-## Development status
-The Android version of SpMp is in beta and is ready for regular use with no major issues, but rough edges are still being actively polished and tweaked.
-
-SpMp is being [ported](https://github.com/toasterofbread/spmp-server) to desktop platforms of [Compose Multiplatform](https://github.com/JetBrains/compose-multiplatform), but is still in a pre-alpha state. Some basic features are working but are yet to be tested thoroughly.
-
-<br>
-
-<img align="right" width="20%" src="metadata/en-US/images/phoneScreenshots/0.png">
-
 # Features
 - Edit song, artist, and playlist titles
 - Select multiple songs for batch actions on any screen
@@ -46,28 +37,48 @@ SpMp is being [ported](https://github.com/toasterofbread/spmp-server) to desktop
 <details open>
     <summary><h2>Screenshots</h2></summary>
     <p align="center">
-        <img src="metadata/en-US/images/phoneScreenshots/7.png" style="max-height:70vh;object-fit:contain;" width="25%">
-        <img src="metadata/en-US/images/phoneScreenshots/8.png" style="max-height:70vh;object-fit:contain;" width="25%">
-        <img src="metadata/en-US/images/phoneScreenshots/1.png" style="max-height:70vh;object-fit:contain;" width="25%">
+        <img src="metadata/en-US/images/phoneScreenshots/landscape_1.png" style="max-height:50vh;object-fit:contain;" width="78%">
+        <img width="21%" src="metadata/en-US/images/phoneScreenshots/8.png" style="max-height:50vh;object-fit:contain;">
+    </p>
+    <p align="center">
+        <img width="21%" src="metadata/en-US/images/phoneScreenshots/1.png" style="max-height:50vh;object-fit:contain;">
+        <img src="metadata/en-US/images/phoneScreenshots/landscape_2.png" style="max-height:50vh;object-fit:contain;" width="78%">
     </p>
 </details>
 
 <details closed>
     <summary><h2>More Screenshots</h2></summary>
     <p align="center">
         <img src="metadata/en-US/images/phoneScreenshots/9.png" style="max-height:70vh;object-fit:contain;" width="25%">
-        <img src="metadata/en-US/images/phoneScreenshots/2.png" style="max-height:70vh;object-fit:contain;" width="25%">
+        <img src="metadata/en-US/images/phoneScreenshots/7.png" style="max-height:70vh;object-fit:contain;" width="25%">
         <img src="metadata/en-US/images/phoneScreenshots/4.png" style="max-height:70vh;object-fit:contain;" width="25%">
     </p>
     <p align="center">
-        <img src="metadata/en-US/images/phoneScreenshots/3.png" style="max-height:70vh;object-fit:contain;" width="25%">
+        <img src="metadata/en-US/images/phoneScreenshots/0.png" style="max-height:70vh;object-fit:contain;" width="25%">
         <img src="metadata/en-US/images/phoneScreenshots/5.png" style="max-height:70vh;object-fit:contain;" width="25%">
         <img src="metadata/en-US/images/phoneScreenshots/6.png" style="max-height:70vh;object-fit:contain;" width="25%">
     </p>
 </details>
 
 <br>
 
+## Installation
+
+Downloads for all platforms can be found on the repository's [releases page](https://github.com/toasterofbread/spmp/releases).
+
+#### Additional requirements on desktop
+
+- Java must be installed for all desktop platforms
+- [Several system packages](https://spmp.toastbits.dev/docs/client/installation/#dependencies) are required to use the Linux version
+
+The Android version is also available on F-Droid. There is no difference between APKs available on GitHub and those on F-Droid.
+
+[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" height="80">](https://f-droid.org/en/packages/com.toasterofbread.spmp/)
+
+## Documentation
+
+Documentation on advanced usage of SpMp including compilation instructions can be found at https://spmp.toastbits.dev/docs/
+
 ## About the project
 I started this project after I got tired of dealing with YouTube's official music app's lack of language features and customisation. I tried several alternatives, but all had at least a few issues that bugged me.
 
@@ -78,10 +89,6 @@ Pull requests, bug reports, and feature suggestions are welcome! This is my firs
 
 The app is currently being developed for both English and Japanese. Contributions for other languages would be greatly appreciated! Information about app localisation can be found [here](https://github.com/toasterofbread/spmp/wiki/App-localisation).
 
-## Also available at
-
-[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" height="100">](https://f-droid.org/en/packages/com.toasterofbread.spmp/)
-
 ## Thanks to
 - smlqrs: For designing the project's icon graphic
 - [ytmusicapi](https://github.com/sigma67/ytmusicapi/): Used as a reference for the YouTube Music API

diff --git a/metadata/en-US/images/phoneScreenshots/8.png b/metadata/en-US/images/phoneScreenshots/8.png
diff --git a/metadata/en-US/images/phoneScreenshots/landscape_0.png b/metadata/en-US/images/phoneScreenshots/landscape_0.png
diff --git a/metadata/en-US/images/phoneScreenshots/landscape_1.png b/metadata/en-US/images/phoneScreenshots/landscape_1.png
diff --git a/metadata/en-US/images/phoneScreenshots/landscape_2.png b/metadata/en-US/images/phoneScreenshots/landscape_2.png
diff --git a/readme/README-ja.md b/readme/README-ja.md
@@ -14,18 +14,8 @@
 # SpMp
 UIの色と曲のメタデータのカスタマイズに特化した YouTube Music のアプリ。Androidとデスクトップのプラットフォーム向けに、Compose Multiplatformを使って開発されています。
 
-<br>
-<br>
-
-## 開発状態
-SpMpのAndroid版はただいまベータテスティング中です。普段の使用には使えますが、まだ仕上げができていない部分もあります。
-
-SpMpはデスクトップのプラットフォーム用にも[開発中](https://github.com/toasterofbread/spmp-server)ですが、まだアルファ未満の状態となっています。最低限の機能は動作していますが、テスティングはまだされていません。
-
 <br>
 
-<img align="right" width="20%" src="../metadata/en-US/images/phoneScreenshots/0.png">
-
 ## 機能
 - 曲、アーティスト、またはプレイリストのタイトルを編集
 - どの画面からでも曲を複数選択
@@ -46,28 +36,48 @@ SpMpはデスクトップのプラットフォーム用にも[開発中](https:/
 <details open>
     <summary><h2>スクリーンショット</h2></summary>
     <p align="center">
-        <img src="../metadata/en-US/images/phoneScreenshots/7.png" style="max-height:70vh;object-fit:contain;" width="25%">
-        <img src="../metadata/en-US/images/phoneScreenshots/8.png" style="max-height:70vh;object-fit:contain;" width="25%">
-        <img src="../metadata/en-US/images/phoneScreenshots/1.png" style="max-height:70vh;object-fit:contain;" width="25%">
+        <img src="../metadata/en-US/images/phoneScreenshots/landscape_1.png" style="max-height:50vh;object-fit:contain;" width="78%">
+        <img width="21%" src="../metadata/en-US/images/phoneScreenshots/8.png" style="max-height:50vh;object-fit:contain;">
+    </p>
+    <p align="center">
+        <img width="21%" src="../metadata/en-US/images/phoneScreenshots/1.png" style="max-height:50vh;object-fit:contain;">
+        <img src="../metadata/en-US/images/phoneScreenshots/landscape_2.png" style="max-height:50vh;object-fit:contain;" width="78%">
     </p>
 </details>
 
 <details closed>
     <summary><h2>他のスクリーンショット</h2></summary>
     <p align="center">
         <img src="../metadata/en-US/images/phoneScreenshots/9.png" style="max-height:70vh;object-fit:contain;" width="25%">
-        <img src="../metadata/en-US/images/phoneScreenshots/2.png" style="max-height:70vh;object-fit:contain;" width="25%">
+        <img src="../metadata/en-US/images/phoneScreenshots/7.png" style="max-height:70vh;object-fit:contain;" width="25%">
         <img src="../metadata/en-US/images/phoneScreenshots/4.png" style="max-height:70vh;object-fit:contain;" width="25%">
     </p>
     <p align="center">
-        <img src="../metadata/en-US/images/phoneScreenshots/3.png" style="max-height:70vh;object-fit:contain;" width="25%">
+        <img src="../metadata/en-US/images/phoneScreenshots/0.png" style="max-height:70vh;object-fit:contain;" width="25%">
         <img src="../metadata/en-US/images/phoneScreenshots/5.png" style="max-height:70vh;object-fit:contain;" width="25%">
         <img src="../metadata/en-US/images/phoneScreenshots/6.png" style="max-height:70vh;object-fit:contain;" width="25%">
     </p>
 </details>
 
 <br>
 
+## インストール手順
+
+すべてのプラットフォームのダウンロードは、リポジトリの[リリース ページ](https://github.com/toasterofbread/spmp/releases)にあります。
+
+#### デスクトップ版の追加要件
+
+- Java をインストールする（すべてのプラットフォーム）
+- Linux バージョンには[いくつかのシステム パッケージ](https://spmp.toastbits.dev/docs/client/installation/#dependency)が必要です
+
+Android版は F-Droid からもダウンロードできます。GitHubで入手可能の APK と F-Droid で入手可能の APK に違いはありません。
+
+[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" height="80">](https://f-droid.org/en/packages/com.toasterofbread.spmp/)
+
+## ドキュメンテーション（現在英語のみ）
+
+SpMp の高度な使用法（コンパイル手順など）に関するドキュメンテーションは、https://spmp.toastbits.dev/docs/ にあります。
+
 ## このプロジェクトについて
 YouTube公式のミュージックアプリをしばらく使っていましたが、言語やメタデータの設定機能の無さを感じて別のアプリをいくつか使ってみました。ましな物はあったけど、どれにも重大な問題を一つは感じました。
 
@@ -78,10 +88,6 @@ Pull requestと機能の提案は歓迎です！これは僕の初めてのCompo
 
 このアプリの日本語版も英語版も開発しています。他の言語への貢献も大歓迎です！
 
-## こちらからも入手
-
-[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" height="100">](https://f-droid.org/en/packages/com.toasterofbread.spmp/)
-
 ## 参考にしたソフト
 - smlqrs: 本プロジェクトのアイコンをデザインしてくれました
 - [ytmusicapi](https://github.com/sigma67/ytmusicapi/): YouTube Music APIの使い方の参考にさせてもらいました