Alexander/threadwatcher
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

added install instructions

Browse Source
This commit is contained in:
Alexander Bocken 2021-06-02 12:43:32 +02:00
parent 77fdc3dfc5
commit e3e073998f
Signed by: Alexander
GPG Key ID: 1D237BE83F9B05E8
1 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -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.