mgabarda.com
An application to display the albumn cover of the track played in cmus.
chore: README updated
+27
-11
+27
-11
README.md
+27
-11
README.md
···
1
-
# cmus cover viewer
1
+
# cmus Cover Viewer
2
2
3
3
Small program in Go to display the cover art of the current track playing in
4
-
[cmus](https://cmus.github.io/).
4
+
[cmus](https://cmus.github.io/). This is how it'd look in [kitty](https://sw.kovidgoyal.net/kitty/) terminal and using
5
+
also [cava](https://github.com/karlstav/cava), using kitty windows:
5
6
6
-
This is how it'd look in [kitty](https://sw.kovidgoyal.net/kitty/) terminal and using
7
-
also [cava](https://github.com/karlstav/cava):
7
+
8
+
9
+
## Installation
8
10
9
-
11
+
```bash
12
+
go install tangled.org/mgabarda.com/cover-viewer@latest
13
+
```
10
14
11
-
## How to use
15
+
Or build from source:
16
+
17
+
```bash
18
+
git clone git@tangled.org:mgabarda.com/cover-viewer
19
+
cd code-viewer/
20
+
go build
21
+
```
22
+
23
+
## Usage
12
24
13
25
This program has two modes: **visualizer** to show the cover, and notify to send the
14
26
change in the cover.
15
27
16
28
### Run visualizer
17
29
18
-
```
30
+
The visualizer will be running, waiting to the events from cmus, dispatched using
31
+
`cover-viewer --mode notify`:
32
+
33
+
```bash
19
34
cover-viewer --mode visualizer
20
35
```
21
36
37
+
Currently this has been tested in **kitty**, but it should be compatible with all the
38
+
terminal emulators supported by [go-termning](https://github.com/blacktop/go-termimg).
39
+
22
40
### Notify from cmus
23
41
24
-
This is based on the [status display](https://github.com/cmus/cmus/wiki/status-display-programs#usage--installation) from cmus.
25
-
26
-
Assuming you use multiple programs, with a shell script, e.g.
27
-
~/.cmus/status_display_program.sh, you can add there this visualizer:
42
+
This is based on the [status display](https://github.com/cmus/cmus/wiki/status-display-programs#usage--installation) from cmus. Assuming you use multiple programs, with a shell
43
+
script, e.g. `~/.cmus/status_display_program.sh`, you can add there this visualizer:
28
44
29
45
```bash
30
46
#!/bin/sh