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

Added an installation section to README.md

Browse Source
This commit is contained in:
Tristan Ferrua
2021-01-31 00:17:50 +00:00
parent 97c3bb3a37
commit edf5055838
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -4,6 +4,19 @@ A curses based mpd client with basic functionality and album art written for the
After installation, the player can be opened from Kitty with `miniplayer`. After installation, the player can be opened from Kitty with `miniplayer`.
## Installation
This package can be installed by:
1. Cloning this repository to your computer and running
```
python setup.py install
```
2. Through PyPi with
```
pip install miniplayer
```
3. By installing the `miniplayer-git` package with your AUR package manager of choice.
## Configuration ## Configuration
The config file is located at `~/.config/miniplayer/config`. The example configuration file, `config.example`, has all the default values. The config file is located at `~/.config/miniplayer/config`. The example configuration file, `config.example`, has all the default values.