11 files changed, 244 insertions, 0 deletions

diff --git a/util/install/arch.sh b/util/install/arch.sh
new file mode 100755
index 000000000..33c39212d
--- /dev/null
+++ b/util/install/arch.sh
@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+
+_qmk_install() {
+    echo "Installing dependencies"
+
+    sudo pacman --needed  --noconfirm -S \
+        base-devel clang diffutils gcc git unzip wget zip python-pip \
+        avr-binutils arm-none-eabi-binutils arm-none-eabi-gcc \
+        arm-none-eabi-newlib avrdude dfu-programmer dfu-util \
+        riscv64-elf-binutils riscv64-elf-gcc riscv64-elf-newlib
+    sudo pacman --needed --noconfirm -U https://archive.archlinux.org/packages/a/avr-gcc/avr-gcc-8.3.0-1-x86_64.pkg.tar.xz
+    sudo pacman --needed --noconfirm -S avr-libc # Must be installed after the above, or it will bring in the latest avr-gcc instead
+
+    sudo pacman --needed  --noconfirm -S hidapi  # This will fail if the community repo isn't enabled
+
+    python3 -m pip install --user -r $QMK_FIRMWARE_DIR/requirements.txt
+}
diff --git a/util/install/debian.sh b/util/install/debian.sh
new file mode 100755
index 000000000..3e02919bd
--- /dev/null
+++ b/util/install/debian.sh
@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+
+DEBIAN_FRONTEND=noninteractive
+DEBCONF_NONINTERACTIVE_SEEN=true
+export DEBIAN_FRONTEND DEBCONF_NONINTERACTIVE_SEEN
+
+_qmk_install_prepare() {
+    sudo apt-get update $SKIP_PROMPT
+}
+
+_qmk_install() {
+    echo "Installing dependencies"
+
+    sudo apt-get --quiet --yes install \
+        build-essential clang-format diffutils gcc git unzip wget zip \
+        python3-pip binutils-avr gcc-avr avr-libc binutils-arm-none-eabi \
+        gcc-arm-none-eabi libnewlib-arm-none-eabi avrdude dfu-programmer \
+        dfu-util teensy-loader-cli libhidapi-hidraw0 libusb-dev
+
+    # RISC-V toolchains with picolibc support are only available for distributions based on Debian 11+.
+    if sudo apt-get install --simulate --quiet --yes picolibc-riscv64-unknown-elf gcc-riscv64-unknown-elf binutils-riscv64-unknown-elf > /dev/null 2>&1; then
+        sudo apt-get --quiet --yes install picolibc-riscv64-unknown-elf \
+            gcc-riscv64-unknown-elf \
+            binutils-riscv64-unknown-elf
+    fi
+
+    python3 -m pip install --user -r "$QMK_FIRMWARE_DIR"/requirements.txt
+}
diff --git a/util/install/fedora.sh b/util/install/fedora.sh
new file mode 100755
index 000000000..e123447d3
--- /dev/null
+++ b/util/install/fedora.sh
@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+_qmk_install() {
+    echo "Installing dependencies"
+
+    # TODO: Check whether devel/headers packages are really needed
+    sudo dnf $SKIP_PROMPT install \
+        clang diffutils git gcc glibc-headers kernel-devel kernel-headers \
+        make unzip wget zip python3 avr-binutils avr-gcc avr-libc \
+        arm-none-eabi-binutils-cs arm-none-eabi-gcc-cs arm-none-eabi-newlib \
+        avrdude dfu-programmer dfu-util hidapi
+
+    python3 -m pip install --user -r $QMK_FIRMWARE_DIR/requirements.txt
+}
diff --git a/util/install/freebsd.sh b/util/install/freebsd.sh
new file mode 100755
index 000000000..595911969
--- /dev/null
+++ b/util/install/freebsd.sh
@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+
+_qmk_install_prepare() {
+    sudo pkg update $SKIP_PROMPT
+}
+
+_qmk_install() {
+    echo "Installing dependencies"
+
+    sudo pkg install -y \
+        git wget gmake gcc zip unzip diffutils \
+        python3 \
+        avr-binutils avr-gcc avr-libc \
+        arm-none-eabi-binutils arm-none-eabi-gcc arm-none-eabi-newlib \
+        avrdude dfu-programmer dfu-util
+
+    sudo python3 -m pip install -r $QMK_FIRMWARE_DIR/requirements.txt
+}
diff --git a/util/install/gentoo.sh b/util/install/gentoo.sh
new file mode 100755
index 000000000..b031fc762
--- /dev/null
+++ b/util/install/gentoo.sh
@@ -0,0 +1,34 @@
+#!/usr/bin/env bash
+
+_qmk_install_prepare() {
+    echo "This script will make a USE change in order to ensure that that QMK works on your system."
+    echo "All changes will be sent to the file /etc/portage/package.use/qmkfirmware -- please review it, and read Portage's output carefully before installing any packages on your system."
+    echo "You will also need to ensure that your kernel is compiled with support for the microcontroller that you are using (e.g. enable Arduino for the Pro Micro). Further information can be found on the Gentoo wiki."
+
+    read -p "Proceed? [y/N] " res
+    case $res in
+        [Yy]*)
+            return 0;;
+        *)
+            return 1;;
+    esac
+}
+
+_qmk_install() {
+    echo "Installing dependencies"
+
+    sudo touch /etc/portage/package.use/qmkfirmware
+    # tee is used here since sudo doesn't apply to >>
+    echo "sys-devel/gcc multilib" | sudo tee --append /etc/portage/package.use/qmkfirmware >/dev/null
+    sudo emerge -auN sys-devel/gcc
+    sudo emerge -au --noreplace \
+        app-arch/unzip app-arch/zip net-misc/wget sys-devel/clang \
+        sys-devel/crossdev \>=dev-lang/python-3.7 dev-embedded/avrdude \
+        dev-embedded/dfu-programmer app-mobilephone/dfu-util sys-apps/hwloc \
+        dev-libs/hidapi
+
+    sudo crossdev -s4 --stable --g \<9 --portage --verbose --target avr
+    sudo crossdev -s4 --stable --g \<9 --portage --verbose --target arm-none-eabi
+
+    python3 -m pip install --user -r $QMK_FIRMWARE_DIR/requirements.txt
+}
diff --git a/util/install/linux_shared.sh b/util/install/linux_shared.sh
new file mode 100755
index 000000000..e060f425f
--- /dev/null
+++ b/util/install/linux_shared.sh
@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+# For those distros that do not package bootloadHID
+_qmk_install_bootloadhid() {
+    if ! command -v bootloadHID > /dev/null; then
+        wget https://www.obdev.at/downloads/vusb/bootloadHID.2012-12-08.tar.gz -O - | tar -xz -C /tmp
+        pushd /tmp/bootloadHID.2012-12-08/commandline/ > /dev/null
+        if make; then
+            sudo cp bootloadHID /usr/local/bin
+        fi
+        popd > /dev/null
+    fi
+}
diff --git a/util/install/macos.sh b/util/install/macos.sh
new file mode 100755
index 000000000..870b4bec9
--- /dev/null
+++ b/util/install/macos.sh
@@ -0,0 +1,26 @@
+#!/usr/bin/env bash
+
+_qmk_install_prepare() {
+    echo "Checking Homebrew installation"
+
+    if ! brew --version >/dev/null 2>&1; then
+        echo "Error! Homebrew is broken or not installed."
+        echo "Please run \`brew doctor\` or follow the installation instructions at https://brew.sh/, then re-run this script."
+        return 1
+    fi
+
+    brew update && brew upgrade --formulae --ignore-pinned
+}
+
+_qmk_install() {
+    echo "Installing dependencies"
+
+    # All macOS dependencies are managed in the Homebrew package:
+    # https://github.com/qmk/homebrew-qmk
+    brew install qmk/qmk/qmk
+
+    brew link --force avr-gcc@8
+    brew link --force arm-gcc-bin@8
+
+    python3 -m pip install -r $QMK_FIRMWARE_DIR/requirements.txt
+}
diff --git a/util/install/msys2.sh b/util/install/msys2.sh
new file mode 100755
index 000000000..203f8eff0
--- /dev/null
+++ b/util/install/msys2.sh
@@ -0,0 +1,35 @@
+#!/usr/bin/env bash
+
+_qmk_install_prepare() {
+    pacman -Syu $MSYS2_CONFIRM
+}
+
+_qmk_install() {
+    echo "Installing dependencies"
+
+    pacman --needed --noconfirm --disable-download-timeout -S pactoys-git
+    pacboy sync --needed --noconfirm --disable-download-timeout \
+        base-devel: toolchain:x clang:x git: unzip: python3-pip:x \
+        avr-binutils:x avr-gcc:x avr-libc:x arm-none-eabi-binutils:x \
+        arm-none-eabi-gcc:x arm-none-eabi-newlib:x avrdude:x bootloadhid:x \
+        dfu-programmer:x dfu-util:x teensy-loader-cli:x hidapi:x
+
+    _qmk_install_drivers
+
+    python3 -m pip install -r "$QMK_FIRMWARE_DIR/requirements.txt"
+}
+
+_qmk_install_drivers() {
+    echo "Installing drivers"
+
+    tmpdir=$(mktemp -d)
+    cp "$QMK_FIRMWARE_UTIL_DIR/drivers.txt" $tmpdir
+    pushd $tmpdir > /dev/null
+
+    wget "https://github.com/qmk/qmk_driver_installer/releases/download/v1.01/qmk_driver_installer.exe"
+
+    cmd.exe //c "qmk_driver_installer.exe --all --force drivers.txt"
+
+    popd > /dev/null
+    rm -r $tmpdir
+}
diff --git a/util/install/slackware.sh b/util/install/slackware.sh
new file mode 100755
index 000000000..df4d073e7
--- /dev/null
+++ b/util/install/slackware.sh
@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+
+_qmk_install_prepare() {
+    echo "Before you continue, please ensure that your user is added to sudoers and that sboinstall is configured."
+    read -p "Proceed? [y/N] " res
+
+    case $res in
+        [Yy]*)
+            ;;
+        *)
+            return 1;;
+    esac
+}
+
+_qmk_install() {
+    echo "Installing dependencies"
+
+    sudo sboinstall \
+        avr-binutils avr-gcc avr-libc \
+        arm-binutils arm-gcc newlib \
+        python3 \
+        avrdude dfu-programmer dfu-util teensy_loader_cli
+
+    python3 -m pip install --user -r $QMK_FIRMWARE_DIR/requirements.txt
+}
diff --git a/util/install/solus.sh b/util/install/solus.sh
new file mode 100755
index 000000000..fad0605cf
--- /dev/null
+++ b/util/install/solus.sh
@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+_qmk_install_prepare() {
+    sudo eopkg -y update-repo
+    sudo eopkg -y upgrade
+}
+
+_qmk_install() {
+    echo "Installing dependencies"
+
+    sudo eopkg -y install \
+        -c system.devel git wget zip unzip \
+        python3 \
+        avr-binutils avr-gcc avr-libc \
+        arm-none-eabi-binutils arm-none-eabi-gcc arm-none-eabi-newlib \
+        avrdude dfu-programmer dfu-util
+
+    python3 -m pip install --user -r $QMK_FIRMWARE_DIR/requirements.txt
+}
diff --git a/util/install/void.sh b/util/install/void.sh
new file mode 100755
index 000000000..6aeb8e00a
--- /dev/null
+++ b/util/install/void.sh
@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+
+_qmk_install() {
+    echo "Installing dependencies"
+
+    sudo xbps-install $SKIP_PROMPT \
+        gcc git make wget unzip zip \
+        python3-pip \
+        avr-binutils avr-gcc avr-libc \
+        cross-arm-none-eabi-binutils cross-arm-none-eabi-gcc cross-arm-none-eabi-newlib \
+        avrdude dfu-programmer dfu-util teensy_loader_cli \
+        libusb-compat-devel
+
+    python3 -m pip install --user -r $QMK_FIRMWARE_DIR/requirements.txt
+}