From 2243ec7ae7519c71511fd790010b95391708d112 Mon Sep 17 00:00:00 2001 From: Karma Riuk Date: Sun, 19 Sep 2021 15:10:39 +0200 Subject: [PATCH] Updated README --- README.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 73f2406..96dd886 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,32 @@ # Volumectl -A small script that bundles volume control and notification. Intended to be used either on command line or for keyboard shortcuts. +A small script that bundles volume control and dunst notification. Intended to be used either on command line or for keyboard shortcuts. + + +## Installation + +### Dependencies + +#### Dunst +Before installing and using this script, you will need to install the official `[dunst](https://wiki.archlinux.org/title/Dunst)` package. +Make sure you have the `dunstify` command available, that's what is needed to +have a nice looking percentage bar. + +#### Bash Ini Reader + +In order to use a custom config file (which is optional, the script works +without it but it's uselful if you want to customise it), you need to install +the `[read_ini.sh](https://raw.githubusercontent.com/rudimeier/bash_ini_parser/master/read_ini.sh)` script. + +You can do it in two different ways: + +##### Downlading the script directly +```bash +mkdir -p $HOME/.local/lib +wget -O $HOME/.local/lib/read_ini.sh https://raw.githubusercontent.com/rudimeier/bash_ini_parser/master/read_ini.sh +chmod +x $HOME/.local/lib/read_ini.sh +``` + + +### Installing the script