Improve readme

[KnightTheCoder]

Requirements

• systemd (recommended but not required for some parts of the scripts)
• bash
• whiptail (optional, the script will install it if not found)

Motivation

• The need for a quick way to setup a new vm/system to test and use

Steps the script runs:

• Find package manager
• Check for whiptail and install it if it's not found
• Find Distro, ask if distro is correct, if distro and package manager don't match stop script
• Start distro specific script
• Select programs/tools to install
• Add list of recommended packages (bat, eza, git, etc.)
• Select shells to setup
• Select neovim configuration
• Break down programs/tools into setup steps (packages, services, usergroups, setups, etc.)
• Distro specific setup (add repos, install codecs, etc.)
• Add user to usergroups listed before
• Run setups for selected apps
• Start listed services
• Ask for hostname (optional)

Project breakdown

Project structure:

.
├── config
│   ├── firefox
│   │   └── policies.json
│   ├── fish
│   │   ├── config_debian.fish
│   │   └── config.fish
│   └── vscode
│       ├── keybindings.json
│       └── settings.json
├── distros
│   ├── arch
│   │   ├── README.md
│   │   └── setup.sh
│   ├── debian
│   │   ├── README.md
│   │   └── setup.sh
│   ├── fedora
│   │   ├── README.md
│   │   └── setup.sh
│   └── opensuse
│       ├── README.md
│       └── setup.sh
├── LICENSE
├── post_install.sh
├── README.md
└── shared
    ├── setup.fish
    ├── setup.zsh
    └── shared_scripts.sh

Config

Pre-made configuration files, these are meant to be copied and not changed

Distros

Distro specific setups that will execute the specific steps for them: example: using the distro's package manager and approprioate package names, repos

Shared:

Shared scripts between all distro setups, these include shell setup and program specific setups like installing hack nerd fonts, setting up scripts with plugin managers, neovim configurations, flatpaks, etc.