From 84665faeac2e721698dcfdb40d13a3db65e76f80 Mon Sep 17 00:00:00 2001 From: Simon Garrelou Date: Fri, 9 Dec 2022 15:20:41 +0100 Subject: Update README --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 8ad32e2..8984327 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ This project implements a terminal-based client for any [Subsonic](https://www.subsonic.org)-compatible server. +It currently supports the following: +- Browsing of Subsonic library organised by Artists and Albums +- Playback of OGG, FLAC and MP3 files + ## Building This application requires [Go](https://go.dev) version 1.19 at minimum. @@ -11,8 +15,11 @@ $ git clone https://git.sixfoisneuf.fr/termsonic && cd termsonic $ go build -o termsonic ./cmd ``` +### Linux notes Please note that Linux builds additionally need a working C compiler in their PATH. This is due to [faiface/beep](https://github.com/faiface/beep), used for audio playback. +You will also need the ALSA development libraries for your system. On Debian, this is `libasound2-dev`. + ## Configuration The application reads its configuration from `$XDG_CONFIG_DIR/termsonic.toml`, or `~/.config/termsonic.toml` if `XDG_CONFIG_DIR` doesn't exist. -- cgit v1.2.3