Merge pull request #1090 from AladW/repo-default-status
[aurutils.git] / README.md
bloba0c824042da6f5dae43341f805544abaa43245cd
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)
4 ## SYNOPSIS
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.
11 The chosen approach for managing packages is local pacman
12 repositories, rather than foreign (installed by `pacman -U`)
13 packages.
14   
15 ## INSTALLATION
17 Install one of the following packages:
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.
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)
28 ## USAGE
30 Documentation is included as groff manuals. [`aur(1)`](man1/aur.1) contains a
31 general overview, instructions on creating a local repository, and
32 several examples.
34 ## TROUBLESHOOTING
36 See [ISSUE_TEMPLATE.md](ISSUE_TEMPLATE.md). For informal discussion, see the
37 `#aurutils` channel on [Libera Chat](https://libera.chat/).
38