From edf5055838aeb2ec6054265614341cfbc4d59196 Mon Sep 17 00:00:00 2001 From: Tristan Ferrua Date: Sun, 31 Jan 2021 00:17:50 +0000 Subject: [PATCH] Added an installation section to README.md --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index c5a5b04..07e4db4 100644 --- a/README.md +++ b/README.md @@ -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`. +## 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 The config file is located at `~/.config/miniplayer/config`. The example configuration file, `config.example`, has all the default values.