# Getting started
The Python requirements are all in `requirements.txt`, so before starting you need to issue the following command:
```sh
$ pip install -r requirements.txt --user
```
**without** using sudo. Using sudo with pip is a bad idea because it will interfere with your distribution's package manager.

# About the files in the repo
* `arch-desktop_borg.sh`

    Borg backup script. Used by a pacman hook to backup my system.

* `configs.yml`

    Lists the things to install, which includes programs, symlinks, git clones, shell commands...

* `dotfiles/`

    The actual dotfiles. They are symlinked to the location that the system expects to find them.

* `git_hooks/`

    See `symlink_git_hooks.sh`.

* `install.py`

    Installs everything using `configs.yml`. This is the file to actually run.

* `firefox_addons.txt`

    I like to install my Firefox add-ons manually in the Firefox add-on manager, so this file just reminds me what to install and includes the urls to each add-on.

* `pacman_hooks/`

    You need to manually copy or symlink any hook to `/etc/pacman.d/hooks/` to activate it.

* `shellcheck_binary_fix.sh`

    When running this on Manjaro, pacman was unable to find the shellcheck package, so this script installs the pre-compiled binary instead. If your package manager finds shellcheck, this script won't run.

* `symlink_git_hooks.sh`

    Helper script to symlink any hook in `git_hooks/` to your local `.git/hooks/` folder. Only for personal use to keep my git hooks version controlled.

* `todo`

    Never seems to remain empty...