Merge pull request #963 from AladW/view-options
[aurutils.git] / README.md
blob877127ed29fc1423d0886ae7518fe7998b0d927d
1 ## SYNOPSIS
2   
3 ![logo](06Nitori1.png)
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.
10 The chosen approach for managing packages is local pacman
11 repositories, rather than foreign (installed by `pacman -U`)
12 packages.
13   
14 ## INSTALLATION
16 Install one of the following packages:
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.
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)
27 ## USAGE
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.
33 ## TROUBLESHOOTING
35 See [ISSUE_TEMPLATE.md](ISSUE_TEMPLATE.md). For informal discussion, see the
36 `#aurutils` channel on [Libera Chat](https://libera.chat/).
37