Installation Guide

This guide covers various methods for installing aurutils and its dependencies.

From the AUR (Recommended)

The easiest way to install aurutils is from the Arch User Repository itself. You will need an existing AUR helper or know how to build AUR packages manually.

Stable Release: For the latest tagged release version, install the aurutils package.
```
# Using another AUR helper like 'yay' or 'paru'
yay -S aurutils
```
Development Version: To use the latest commit from the master branch, install aurutils-git.
```
yay -S aurutils-git
```

Dependencies

aurutils relies on a set of core tools to function. You should ensure they are installed on your system.

Required Dependencies

These packages are necessary for aurutils to work:

pacman -S git pacutils curl trurl bash perl perl-json-xs

Optional Dependencies

These packages enable additional features and are highly recommended for a complete experience:

bash-completion: Provides command-line completion for Bash.
zsh: Provides command-line completion for Zsh.
devtools: Required for chroot builds using aur-chroot.
vifm: The default file manager for inspecting build files with aur-view.
ninja: Enables parallel builds and better failure handling in aur-sync.
bat: Used by the view-delta example script for syntax highlighting.
git-delta: Used by the view-delta example script for side-by-side diffs.
python-srcinfo: Required for the sync-rebuild example script.

Install them with:

pacman -S bash-completion zsh devtools vifm ninja bat git-delta python-srcinfo

From Source

If you prefer to build from source:

Clone the repository:

git clone https://github.com/aurutils/aurutils.git
cd aurutils

Build the project: The Makefile handles the build process, which primarily involves substituting version and path variables into the scripts.
```
make build
```
Install the files: This command will install the scripts, man pages, and other assets to their default locations (usually under /usr).
```
sudo make install
```

Using Docker

A Dockerfile is provided to create a containerized Arch Linux environment with aurutils and its dependencies pre-installed.

Navigate to the docker directory in the cloned repository.
Build the Docker image:
```
docker build -t aurutils-env .
```
Run the container:
```
docker run -it --rm aurutils-env
```

This provides a sandboxed environment for using aurutils, which is particularly useful for testing or isolated builds.