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 ## USAGE
  28
  29 Documentation is included as groff manuals. [`aur(1)`](man1/aur.1) contains a
  30 general overview, instructions on creating a local repository, and
  31 several examples.
  32
  33 ## VERSIONING
  34
  35 |Code changes||
  36 |----|----|
  37 |*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.|
  38 |*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.|
  39 |*Minor changes* (compatible)|Result in a bump of maintenance version (`x.y.z`). Typically used for bug fixes or new, compatible features.|
  40
  41 ## TROUBLESHOOTING
  42
  43 See [ISSUE_TEMPLATE.md](ISSUE_TEMPLATE.md). For informal discussion, see the
  44 `#aurutils` channel on [freenode](https://freenode.net/kb/answer/chat).
  45
  46 ## SEE ALSO
  47
  48 The following (third-party) projects may be used together with `aurutils`:
  49
  50 * [aur-talk](https://aur.archlinux.org/packages/aur-talk-git/) - fetch and display AUR package comments (requires: [hq](https://www.archlinux.org/packages/community/x86_64/hq/))
  51 * [aur-out-of-date](https://aur.archlinux.org/packages/aur-out-of-date/) - compare AUR to upstream version
  52 * [aurto](https://aur.archlinux.org/packages/aurto/) - automatically update a local repository with trust management
  53 * [rebuild-detector](https://aur.archlinux.org/packages/rebuild-detector/) - detects which packages need to be rebuilt