README.md

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