Nulo/qmk_firmware
1
0
Fork 0
Code Releases Activity

Suggest 'QMK MSYS' as the default windows platform (#11321)

Browse source 
* Suggest 'QMK MSYS' as the default windows platform

* Review comments
This commit is contained in:
Joel Challis 2021-01-08 19:09:28 +00:00 committed by GitHub
parent b609a07b45
commit 6d9b4c7b4f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
docs/newbs_getting_started.md
View file

@ -41,6 +41,19 @@ We've tried to make QMK as easy to set up as possible. You only have to prepare
### ** Windows ** ### ** Windows **
QMK maintains a Bundle of MSYS2, the CLI and all necessary dependencies. It also provides a handy `QMK MSYS` terminal shortcut to boot you directly into the correct environment.
#### Prerequisites
You will need to install `QMK MSYS`. The latest release is available at https://msys.qmk.fm/.
Alternatively, if you'd like to manually install msys2, the following section will walk you through the process.
<details>
<summary>Manual Install</summary>
?> Ignore the following steps if you use `QMK MSYS`.
#### Prerequisites #### Prerequisites
You will need to install MSYS2, Git and Python. Follow the installation instructions on https://www.msys2.org. You will need to install MSYS2, Git and Python. Follow the installation instructions on https://www.msys2.org.
@ -59,6 +72,8 @@ Install the QMK CLI by running:
python3 -m pip install qmk python3 -m pip install qmk
</details>
### ** macOS ** ### ** macOS **
QMK maintains a Homebrew tap and formula which will automatically install the CLI and all necessary dependencies. QMK maintains a Homebrew tap and formula which will automatically install the CLI and all necessary dependencies.