README.md

   1 [![build](https://img.shields.io/github/workflow/status/aladw/aurutils/CI)](https://github.com/AladW/aurutils/actions/workflows/ci.yml)
   2 [![license](https://img.shields.io/github/license/aladw/aurutils)](LICENSE)
   3 [![aur](https://img.shields.io/aur/version/aurutils)](https://aur.archlinux.org/packages/aurutils)
   4
   5 ## SYNOPSIS
   6
   7 __aurutils__ is a collection of scripts to automate usage of the [Arch
   8 User Repository](https://wiki.archlinux.org/index.php/Arch_User_Repository),
   9 with different tasks such as package searching, update checks, or computing
  10 dependencies kept separate.
  11
  12 The chosen approach for managing packages is local pacman
  13 repositories, rather than foreign (installed by `pacman -U`)
  14 packages.
  15
  16 ## INSTALLATION
  17
  18 Install one of the following packages:
  19
  20 * [`aurutils`](https://aur.archlinux.org/packages/aurutils) for the
  21 release version _(recommended)_.
  22 * [`aurutils-git`](https://aur.archlinux.org/packages/aurutils-git)
  23 for the master branch.
  24
  25 Upgrade notices are posted to the
  26 [Arch forums](https://bbs.archlinux.org/viewtopic.php?id=210621).
  27 [(RSS)](https://bbs.archlinux.org/extern.php?action=feed&tid=210621&type=atom)
  28
  29 ## USAGE
  30
  31 Documentation is included as groff manuals. [`aur(1)`](man1/aur.1) contains a
  32 general overview, instructions on creating a local repository, and
  33 several examples.
  34
  35 ## TROUBLESHOOTING
  36
  37 See [ISSUE_TEMPLATE.md](ISSUE_TEMPLATE.md). For informal discussion, see the
  38 `#aurutils` channel on [Libera Chat](https://libera.chat/).
  39