From c585dc103ab407989d5e536b5c34e2e1d12b0449 Mon Sep 17 00:00:00 2001 From: Drew Weymouth Date: Sun, 5 Mar 2023 10:41:42 -0800 Subject: [PATCH] add installation section to README --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 3eb449b..1bdae1a 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,12 @@ A lightweight cross-platform desktop client for Subsonic music servers (Navidrom * [ ] iOS/Android support (eventually planned) * [ ] Lyrics support (eventually planned) +## Installation + +Download the latest release for your operating system. If you prefer to build from source, or there is no release build currently offered for your OS/architecture (Apple silicon Macs), then see below. + +**If you are on Linux** you must have libmpv installed on your system. On apt-based systems, run `sudo apt install libmpv` if it is not already installed. The Windows and Mac release builds bundle the mpv dependencies. + ## Build instructions (Ubuntu) ### Install dependencies @@ -43,6 +49,7 @@ A lightweight cross-platform desktop client for Subsonic music servers (Navidrom ### 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_linux`` to generate an installable .tar.xz bundle ## Build instructions (Mac OS) @@ -58,6 +65,7 @@ A lightweight cross-platform desktop client for Subsonic music servers (Navidrom * 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 ## Build instructions (Windows)