allen/miniplayer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Tristan Ferrua
2021-01-29 14:29:05 +00:00
committed by GitHub
parent b75f0a2471
commit da17a9460c
1 changed files with 22 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -1,2 +1,23 @@
# miniplayer
# Miniplayer
A curses based mpd client with basic functionality and album art written for the Kitty terminal.
## Configuration
The config file is located at `~/.config/miniplayer/config`. The example configuration file, `config.example`, has all the default values.
* ***music_directory*:** The path to your music directory for extracting album art.
* ***font_width*:** The width of your font in pixels in the actual terminal.
* ***font_height*:** The height of your font in pixels in the actual terminal.
## Keybinds
| Key | function |
|-----|---------------|
| h | Show keybinds |
| p | Play/pause |
| > | Next track |
| < | Last track |
| q | Quit |
| + | Volume +5 |
| - | Volume -5 |