mcg/README.md

# CoverGrid

CoverGrid (mcg) is a client for the [Music Player
Daemon](http://www.musicpd.org) (MPD), focusing on albums instead of single
tracks. It is not intended to be a replacement for your favorite MPD client but
an addition to get a better album-experience.

Website: [https://www.suruatoel.xyz/codes/mcg](www.suruatoel.xyz/codes/mcg)

License: [GPL](http://www.gnu.org/licenses/gpl.html) v3

Dependencies:

* [GTK](http://www.gtk.org) 4 (>= 4.18)
* [libadwaita](https://gnome.pages.gitlab.gnome.org/libadwaita/) (>= 1.2)
* [go](https://go.dev/) (build only)

Additionally, an [MPD](http://www.musicpd.org) server (version >= 0.21.0) is
required at runtime.


## Building

Build the application with _go_:

    $ go build .

## Running

Run the application for testing purposes:

    $ go run .

Run the application:

    $ ./mcg

## Packaging

The suggested package name for this project is “mcg”. To build a production
binary, please use the following command:

    $ go build --ldflags="-s -w -X main.Version=$(git describe)" -trimpath ./...

In the “data/” folder you will find a `.desktop` file and an SVG icon.

## Screenshots

![CoverGrid’s cover panel with album details and track list.](https://www.suruatoel.xyz/images/mcg-cover-s.png "CoverGrid’s cover panel with album details and track list.")

![CoverGrid’s playlist panel with queued albums.](https://www.suruatoel.xyz/images/mcg-playlist.png "CoverGrid’s playlist panel with queued albums.")

![CoverGrid’s library panel showing the albums middle-sized.](https://www.suruatoel.xyz/images/mcg-library-m.png "CoverGrid’s library panel showing the albums middle-sized.")

![CoverGrid’s library panel showing the albums small-sized.](https://www.suruatoel.xyz/images/mcg-library-s.png "CoverGrid’s library panel showing the albums small-sized.")