diff options
| author | Simon Garrelou <simon.garrelou@gmail.com> | 2022-12-09 15:20:41 +0100 |
|---|---|---|
| committer | Simon Garrelou <simon.garrelou@gmail.com> | 2022-12-09 15:20:41 +0100 |
| commit | 84665faeac2e721698dcfdb40d13a3db65e76f80 (patch) | |
| tree | f7783725ed60fbc3d424d7f9399897e330395169 | |
| parent | ce61bb205eb6b2e3227f6686c9f1b6ac4dc3e268 (diff) | |
| download | termsonic-84665faeac2e721698dcfdb40d13a3db65e76f80.tar.gz termsonic-84665faeac2e721698dcfdb40d13a3db65e76f80.zip | |
Update README
| -rw-r--r-- | README.md | 7 |
1 files changed, 7 insertions, 0 deletions
| @@ -2,6 +2,10 @@ | |||
| 2 | 2 | ||
| 3 | This project implements a terminal-based client for any [Subsonic](https://www.subsonic.org)-compatible server. | 3 | This project implements a terminal-based client for any [Subsonic](https://www.subsonic.org)-compatible server. |
| 4 | 4 | ||
| 5 | It currently supports the following: | ||
| 6 | - Browsing of Subsonic library organised by Artists and Albums | ||
| 7 | - Playback of OGG, FLAC and MP3 files | ||
| 8 | |||
| 5 | ## Building | 9 | ## Building |
| 6 | 10 | ||
| 7 | This application requires [Go](https://go.dev) version 1.19 at minimum. | 11 | 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 | |||
| 11 | $ go build -o termsonic ./cmd | 15 | $ go build -o termsonic ./cmd |
| 12 | ``` | 16 | ``` |
| 13 | 17 | ||
| 18 | ### Linux notes | ||
| 14 | 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. | 19 | 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. |
| 15 | 20 | ||
| 21 | You will also need the ALSA development libraries for your system. On Debian, this is `libasound2-dev`. | ||
| 22 | |||
| 16 | ## Configuration | 23 | ## Configuration |
| 17 | 24 | ||
| 18 | The application reads its configuration from `$XDG_CONFIG_DIR/termsonic.toml`, or `~/.config/termsonic.toml` if `XDG_CONFIG_DIR` doesn't exist. | 25 | The application reads its configuration from `$XDG_CONFIG_DIR/termsonic.toml`, or `~/.config/termsonic.toml` if `XDG_CONFIG_DIR` doesn't exist. |