owen/supersonic
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Drew Weymouth
2024-01-08 09:13:13 -08:00
committed by GitHub
parent daa1c44535
commit f74d1cc730
1 changed files with 17 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+17 -4
View File
@@ -23,6 +23,19 @@ Screenshots of Supersonic running against the Navidrome demo server, showcasing
<a href="https://raw.githubusercontent.com/dweymouth/supersonic/main/res/screenshots/ArtistView.png"><img src="https://raw.github.com/dweymouth/supersonic/main/res/screenshots/ArtistView.png" width="49.5%"/></a>
<a href="https://raw.githubusercontent.com/dweymouth/supersonic/main/res/screenshots/FavoriteSongsView.png"><img src="https://raw.github.com/dweymouth/supersonic/main/res/screenshots/FavoriteSongsView.png" width="49.5%"/></a>
## Supported servers
Supersonic supports any music server with a Subsonic (or OpenSubsonic) API, or Jellyfin. A partial list of supported servers is as follows:
* [Navidrome](https://navidrome.org)
* [Jellyfin](https://jellyfin.org)
* [Gonic](https://github.com/sentriz/gonic)
* [LMS](https://github.com/epoupon/lms)
* [Airsonic-Advanced](https://github.com/airsonic-advanced/airsonic-advanced)
* [Ampache](https://ampache.org)
* [Funkwhale](https://www.funkwhale.audio/)
* [Supysonic](https://github.com/spl0k/supysonic)
## Features
* [x] Fast, lightweight, native UI with infinite scrolling
* [x] Light and Dark themes, with optional auto theme switching
@@ -49,7 +62,7 @@ Screenshots of Supersonic running against the Navidrome demo server, showcasing
On Linux, Supersonic is [available as a Flatpak](https://flathub.org/apps/details/io.github.dweymouth.supersonic)! (Thank you @anarcat!) If you prefer to directly install the release build, or build from source, read below.
If you are running Windows, Mac OS, or a Debian-based Linux distro, download the latest [release](https://github.com/dweymouth/supersonic/releases) for your operating system. Tou can also download the latest build from the `main` branch via the [Actions](https://github.com/dweymouth/supersonic/actions) tab for Intel Macs and Debian-based Linux, to get unreleased features and bug fixes (you must be signed in to Github to do this). If you prefer to build from source, or are not running one of these OSes, then see the build instructions for your platform below.
If you are running **Windows**, **Mac OS**, or a **Debian**-based Linux distro, download the [latest release](https://github.com/dweymouth/supersonic/releases) for your operating system. You can also download the latest build from the `main` branch via the [Actions](https://github.com/dweymouth/supersonic/actions) tab to get unreleased features and bug fixes (you must be signed in to Github to do this). If you prefer to build from source, or are not running one of these OSes, then see the build instructions for your platform below.
**Apple Silicon (M1/M2) Macs:** You will have to remove the "quarantine bit" that Mac will automatically set, being an application downloaded from the internet. After copying the .app bundle to your Applications folder, in the terminal run `sudo xattr -r -d com.apple.quarantine /Applications/Supersonic.app`
@@ -65,7 +78,7 @@ If you are running Windows, Mac OS, or a Debian-based Linux distro, download the
* ``sudo dnf install golang mpv-devel libX11-devel libXcursor-devel libXrandr-devel libXinerama-devel libXi-devel libglvnd-devel libXxf86vm-devel``
### Build
* clone the repo, CD into the repo root, and run ``go build .``
* clone the repo, CD into the repo root, and run ``go build``
* (note that the first build will take some time as it will download and build the UI library)
### Generate installable .tar.xz bundle
@@ -104,7 +117,7 @@ Supersonic is available in the AUR and can be built either manually with `makepk
- ``export C_INCLUDE_PATH=/opt/homebrew/include:$C_INCLUDE_PATH``
- ``export LIBRARY_PATH=/opt/homebrew/lib:$LIBRARY_PATH``
* clone the repo, CD into the repo root, and run ``go build .``
* clone the repo, CD into the repo root, and run ``go build``
* (note that the first build will take some time as it will download and build the UI library)
* run ``make package_macos`` to generate the .app bundle
* **If** you are on Mac OS **High Sierra** through **Catalina**, run ``make bundledeps_macos_highsierra`` and you are done! Otherwise, continue reaading.
@@ -119,7 +132,7 @@ Supersonic is available in the AUR and can be built either manually with `makepk
* install libmpv (in the MSYS2 terminal, ``pacman -S mingw-w64-x86_64-mpv``)
### Build
* in the MSYS2 terminal: clone the repo, CD into the repo root, and run ``go build .``
* in the MSYS2 terminal: clone the repo, CD into the repo root, and run ``go build``
* (note that the first build will take some time as it will download and build the UI library)
* **Note**: The .exe dynamically links to MSYS2 libmpv dependency dlls and must be started from the MSYS2 terminal, or all dependency DLLS must be copied to the same folder as the .exe
* -> If you obtain a statically built mpv-2.dll (containing all its dependencies), and rename it to libmpv-2.dll, you can place just that DLL in the same directory as the EXE, and it should run