README.md

<!--
SPDX-FileCopyrightText: 2023 witcher <witcher@wiredspace.de>

SPDX-License-Identifier: CC0-1.0
-->

# helpaur

helpaur is a program that helps you to maintain packages in the
[AUR](https://aur.archlinux.org) by allowing you to list all installed packages
by specific criteria.

Installed packages can be queried by the following criteria:

- Flagged out-of-date
- Orphaned

## Compiling

Install the dependencies:

- Rust

Compile with:

```
cargo build
```

## Usage

All query operations are found as subcommands to the `helpaur` command. For
example, querying all installed AUR packages for orphaned ones:

```
helpaur orphaned
```

Use `helpaur --help` for more information.

## Resources

Send patches and questions to
[~witcher/public-inbox@lists.sr.ht](https://lists.sr.ht/~witcher/public-inbox).

Instructions for preparing a patch are available at
[git-send-email.io](https://git-send-email.io/).