README.md

   1 ## SYNOPSIS
   2
   3 ![logo](06Nitori1.png)
   4
   5 __aurutils__ is a collection of scripts to automate usage of the [Arch
   6 User Repository](https://wiki.archlinux.org/index.php/Arch_User_Repository),
   7 with different tasks such as package searching, update checks, or computing
   8 dependencies kept separate.
   9
  10 The chosen approach for managing packages is local pacman
  11 repositories, rather than foreign (installed by `pacman -U`)
  12 packages.
  13
  14 ## INSTALLATION
  15
  16 Install one of the following packages:
  17
  18 * [`aurutils`](https://aur.archlinux.org/packages/aurutils) for the
  19 release version _(recommended)_.
  20 * [`aurutils-git`](https://aur.archlinux.org/packages/aurutils-git)
  21 for the master branch.
  22
  23 Upgrade notices are posted to the
  24 [Arch forums](https://bbs.archlinux.org/viewtopic.php?id=210621).
  25 [(RSS)](https://bbs.archlinux.org/extern.php?action=feed&tid=210621&type=atom)
  26
  27 ### SIGNATURES
  28
  29 Release archives are signed with `signify` with the following public keys:
  30
  31 * `RWQawitEue1JU2SxUyRD8LXP8m36QsbaHOkKfvZBfhj00EXBYiDZilp0` for `2.3.x`;
  32 * `RWQcfDbvctqX5i5yNDNqu607LC7mKArHMsq7ziT8ynx9bQwj5m5ZpMJY` for `3.0.x`;
  33 * `RWSiKm8qeKjPfppkN7lm/N4qENa3Racl7DRMfWK4JQS7bl2i/NuI3ZZG` for `3.1.x`;
  34
  35 The above keys are also published on [ArchWiki](https://wiki.archlinux.org/index.php/User:Alad#Signing_keys).
  36
  37 A release archive can be verified with the following command:
  38 ```
  39 signify -V -p aurutils.pub -m <version>.tar.gz
  40 ```
  41
  42 ## USAGE
  43
  44 Documentation is included as groff manuals. [`aur(1)`](man1/aur.1) contains a
  45 general overview, instructions on creating a local repository, and
  46 several examples.
  47
  48 ## VERSIONING
  49
  50 |Code changes||
  51 |----|----|
  52 |*Major changes*|Result in a bump of major version (`x.0.0`). Upgrades to a new major version may require a rewrite of interfacing software, or significant changes in workflow.|
  53 |*Minor changes* (incompatible)|Result in a bump of minor version (`x.y.0`). Typically used when application names or command-line options change in a minor way.|
  54 |*Minor changes* (compatible)|Result in a bump of maintenance version (`x.y.z`). Typically used for bug fixes or new, compatible features.|
  55
  56 ## TROUBLESHOOTING
  57
  58 See [ISSUE_TEMPLATE.md](ISSUE_TEMPLATE.md). For informal discussion, see the
  59 `#aurutils` channel on [Libera Chat](https://libera.chat/).
  60