summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/driver_installation_zadig.md2
-rw-r--r--docs/faq_build.md2
-rw-r--r--docs/newbs_getting_started.md66
3 files changed, 22 insertions, 48 deletions
diff --git a/docs/driver_installation_zadig.md b/docs/driver_installation_zadig.md
index 6fbcfa3bff..13b445b9b6 100644
--- a/docs/driver_installation_zadig.md
+++ b/docs/driver_installation_zadig.md
@@ -4,7 +4,7 @@ QMK presents itself to the host as a regular HID keyboard device, and as such re
4 4
5There are two notable exceptions: the Caterina bootloader, usually seen on Pro Micros, and the HalfKay bootloader shipped with PJRC Teensys, appear as a serial port and a generic HID device respectively, and so do not require a driver. 5There are two notable exceptions: the Caterina bootloader, usually seen on Pro Micros, and the HalfKay bootloader shipped with PJRC Teensys, appear as a serial port and a generic HID device respectively, and so do not require a driver.
6 6
7We recommend the use of the [Zadig](https://zadig.akeo.ie/) utility. If you have set up the development environment with MSYS2, the `qmk_install.sh` script will have already installed the drivers for you. 7We recommend the use of the [Zadig](https://zadig.akeo.ie/) utility. If you have set up the development environment with MSYS2, the QMK CLI installation script will have already installed the drivers for you.
8 8
9## Installation 9## Installation
10 10
diff --git a/docs/faq_build.md b/docs/faq_build.md
index 54ed576c70..05cb3251c8 100644
--- a/docs/faq_build.md
+++ b/docs/faq_build.md
@@ -44,7 +44,7 @@ Pro Micro (Atmega32u4), make sure to include `CONFIG_USB_ACM=y`. Other devices m
44 44
45Issues encountered when flashing keyboards on Windows are most often due to having the wrong drivers installed for the bootloader, or none at all. 45Issues encountered when flashing keyboards on Windows are most often due to having the wrong drivers installed for the bootloader, or none at all.
46 46
47Re-running the QMK installation script (`./util/qmk_install.sh` from the `qmk_firmware` directory in MSYS2 or WSL) or reinstalling the QMK Toolbox may fix the issue. Alternatively, you can download and run the [`qmk_driver_installer`](https://github.com/qmk/qmk_driver_installer) package manually. 47Re-running the QMK installation script (`curl -fsSL https://install.qmk.fm | sh`) or reinstalling the QMK Toolbox may fix the issue. Alternatively, you can download and run the [`qmk_driver_installer`](https://github.com/qmk/qmk_driver_installer) package manually.
48 48
49If that doesn't work, then you may need to download and run Zadig. See [Bootloader Driver Installation with Zadig](driver_installation_zadig) for more detailed information. 49If that doesn't work, then you may need to download and run Zadig. See [Bootloader Driver Installation with Zadig](driver_installation_zadig) for more detailed information.
50 50
diff --git a/docs/newbs_getting_started.md b/docs/newbs_getting_started.md
index 1d2b60781b..1bc658b9b1 100644
--- a/docs/newbs_getting_started.md
+++ b/docs/newbs_getting_started.md
@@ -50,90 +50,64 @@ You will need to install [MSYS2](https://www.msys2.org). Once installed, close a
50Install the QMK CLI by running: 50Install the QMK CLI by running:
51 51
52```sh 52```sh
53pacman --needed --noconfirm --disable-download-timeout -S git mingw-w64-x86_64-python-qmk 53curl -fsSL https://install.qmk.fm | sh
54``` 54```
55 55
56:::: 56::::
57 57
58==== macOS 58==== macOS
59 59
60QMK maintains a Homebrew tap and formula which will automatically install the CLI and all necessary dependencies.
61
62#### Prerequisites 60#### Prerequisites
63 61
64You will need to install Homebrew. Follow the instructions on https://brew.sh. 62You will need to install Homebrew. Follow the instructions on https://brew.sh.
65 63
66::: tip
67If you are using an Apple Silicon machine, the installation process will take significantly longer because GitHub actions do not have native runners to build binary packages for the ARM and AVR toolchains.
68:::
69
70#### Installation 64#### Installation
71 65
72Install the QMK CLI by running: 66Install the QMK CLI by running:
73 67
74```sh 68```sh
75brew install qmk/qmk/qmk 69curl -fsSL https://install.qmk.fm | sh
76``` 70```
77 71
78==== Linux/WSL 72==== Linux/WSL
79 73
80::: tip
81**Note for WSL users**: By default, the installation process will clone the QMK repository into your WSL home directory, but if you have cloned manually, ensure that it is located inside the WSL instance instead of the Windows filesystem (ie. not in `/mnt`), as accessing it is currently [extremely slow](https://github.com/microsoft/WSL/issues/4197).
82:::
83
84#### Prerequisites
85
86You will need to install Git and Python. It's very likely that you already have both, but if not, one of the following commands should install them:
87
88* Debian / Ubuntu / Devuan: `sudo apt install -y git python3-pip`
89* Fedora / Red Hat / CentOS: `sudo yum -y install git python3-pip`
90* Arch / Manjaro: `sudo pacman --needed --noconfirm -S git python-pip libffi`
91* Void: `sudo xbps-install -y git python3-pip`
92* Solus: `sudo eopkg -y install git python3`
93* Sabayon: `sudo equo install dev-vcs/git dev-python/pip`
94* Gentoo: `sudo emerge dev-vcs/git dev-python/pip`
95
96#### Installation 74#### Installation
97 75
98Install the QMK CLI by running: 76::: info
99 77Many Linux distributions are supported, but not all. Mainstream distributions will have best success -- if possible, choose either Debian or its derivatives (such as Ubuntu, or Mint), CentOS or its derivatives (such as Fedora, or Rocky Linux), and Arch or its derivatives (such as Manjaro, or CachyOS).
100```sh 78:::
101python3 -m pip install --user qmk
102```
103
104Alternatively, install the QMK CLI as a [uv](https://docs.astral.sh/uv/) managed tool, kept isolated in a virtual environment (requires uv to be installed):
105
106```sh
107uv tool install qmk
108```
109
110#### Community Packages
111
112These packages are maintained by community members, so may not be up to date or completely functional. If you encounter problems, please report them to their respective maintainers.
113 79
114On Arch-based distros you can install the CLI from the official repositories (NOTE: at the time of writing this package marks some dependencies as optional that should not be): 80Install the QMK CLI by running:
115 81
116```sh 82```sh
117sudo pacman -S qmk 83curl -fsSL https://install.qmk.fm | sh
118``` 84```
119 85
120You can also try the `qmk-git` package from AUR: 86::: tip
87**Note for WSL users**: By default, the installation process will clone the QMK repository into your WSL home directory, but if you have cloned manually, ensure that it is located inside the WSL instance instead of the Windows filesystem (ie. not in `/mnt`), as accessing it is currently [extremely slow](https://github.com/microsoft/WSL/issues/4197).
88:::
121 89
122```sh 90::: warning
123yay -S qmk-git 91Any QMK packages provided by your distribution's package manager are almost certainly out of date. It is strongly suggested the installation script above is used instead.
124``` 92:::
125 93
126==== FreeBSD 94==== FreeBSD
127 95
128#### Installation 96#### Installation
129 97
98::: warning
99FreeBSD support is provided on a best-effort basis by the community instead of the QMK maintainers. It is strongly suggested that you use either Windows, macOS, or a supported distribution of Linux instead.
100:::
101
130Install the FreeBSD package for QMK CLI by running: 102Install the FreeBSD package for QMK CLI by running:
131 103
132```sh 104```sh
133pkg install -g "py*-qmk" 105pkg install -g "py*-qmk"
134``` 106```
135 107
136NOTE: remember to follow the instructions printed at the end of installation (use `pkg info -Dg "py*-qmk"` to show them again). 108::: info NOTE
109Remember to follow the instructions printed at the end of installation (use `pkg info -Dg "py*-qmk"` to show them again).
110:::
137 111
138::::: 112:::::
139 113