# Table of Contents
[[_TOC_]]

# Automatic Install
**NOTE**: Check [Operating System Statuses](#operating-systems-auto-installation) first!

This script will back up any files it intends to replace to a directory named `dot-files-backup-TIMESTAMP`.

```bash
curl "https://gitlab.orion-technologies.io/philler/dot-files/-/raw/Development/install.bash" | bash
```

## Auto Install Requirements
- Perms
    - sudo access
    - root
- Packages:
    - `gcc`
        - Used for rust cargo installations
    - `git`
        - Used to clone the dot files repository
    - `curl`
        - Used to install various packages such as oh my zsh
    - `sudo`
        - Sudo is invoked on most system-wide commands
        - You may wonder which systems *don't* have `sudo`, it was found that
        the arm images that the Ubuntu docker images provide lack `sudo` as they
        are *very* minimal.
    - `zsh`
        - For `oh my zsh`, and many packages depend upon zsh in these dots

# Manual
```bash
git clone "https://gitlab.orion-technologies.io/philler/dot-files.git" ph-dot-files && cd ph-dot-files
```

From here copy the files you'd like to have to your home directory: `${HOME}`. Recommend taking the ~/.config/
content first. Ensure you make backups 🙂.

# Operating Systems Auto Installation
Below is the status of various operating systems when the installation script is run on them. 
If the OS is not below then it has not been tested to work with the installation script.

## Verified
The following operating systems are verified to work with the installation script:
- CentOS 8
- CentOS 8 Stream

## Broken
Currently the installation script is confirmed to **break** the following installations:
- macOS

<sub>When it is stated *break*, it really means ***break***. Had to restore macOS from a backup... faster than
resolving all the soft link and pathing errors it caused.</sub>