From e3e073998f90a58898c12548c07a5cb94bad73a9 Mon Sep 17 00:00:00 2001 From: Alexander Bocken Date: Wed, 2 Jun 2021 12:43:32 +0200 Subject: [PATCH] added install instructions --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f41dba2..3b19a98 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ MD5 checks are implemented to safe-guard against corrupted files. This script relies mainly on `dmenu` for interactions. -```sh +``` threadwatcher [add URL DL_LOCATION] [list] [edit] [clean] add URL DL_LOCATION @@ -17,6 +17,26 @@ clean deletes threads file. This will not delete already downloaded material. ``` +## Installation + +### AUR +threadwatcher is in the AUR! Using your favorite AUR package manager, paru for example, it's a simple +``` +paru -S threadwatcher +``` +This is the recommended installation version for Arch-based distros. + +### From Source +As the Makefile might suggest, it's +``` +git clone https://github.com/AlexBocken/threadwatcher +cd threadwatcher +make install +``` +root privileges are required for the default install location. +If issues with running the program persist, first check the "Requirements" section below. + + ## Requirements Besides the obvious stuff for shell scripts like `sed`,`awk`,`grep` and other base-devel programs, this script relies on `jq` and, of course, `dmenu`. Make sure these programs are installed.