Update README.md

This commit is contained in:
streetturtle 2017-06-21 16:42:50 -04:00 committed by GitHub
parent 4444a75813
commit 87e5a80aef
1 changed files with 20 additions and 2 deletions

View File

@ -1,11 +1,22 @@
# Spotify widget
This widget displays currently playing song on [Spotify for Linux](https://www.spotify.com/download/linux/) client: ![screenshot](./spo-wid-1.png).
This widget displays currently playing song on [Spotify for Linux](https://www.spotify.com/download/linux/) client: ![screenshot](./spo-wid-1.png) and consists of two parts:
If clicked plays/pauses the music.
- status icon which shows if music is currently playing
- artist and name of the current song playing
## Controls
- left click - play/pause
- scroll up - play next song
- scroll down - play previous song
## Dependencies
Note that widget uses the Arc icon theme, so it should be [installed](https://github.com/horst3180/arc-icon-theme#installation) first under **/usr/share/icons/Arc/** folder.
Also this widget uses the output of the **spotify_stat** script which could be found in the widget folder.
## Installation
First you need to have spotify CLI installed. Here is how you can do it (except widget part): [pavelmakhov.com/2016/02/awesome-wm-spotify](http://pavelmakhov.com/2016/02/awesome-wm-spotify)
@ -22,3 +33,10 @@ s.mytasklist, -- Middle widget
spotify_widget,
...
```
## Troubleshooting
_Status icon (play/pause) is not shown_:
- make **spotify_stat** script executable (by `sudo chmod +x spotify_stat`) and run it in terminal, output should be either `RUNNING` or `CORKED`;
- the **spotify_stat** script is called by **spotify.lua** so make sure that `get_spotify_status_cmd` in **spotify.lua** contains the right path to the script;
- create an issue :octocat:.