Skip to content

Commit

Permalink
Suggest 'QMK MSYS' as the default windows platform (#11321)
Browse files Browse the repository at this point in the history
* Suggest 'QMK MSYS' as the default windows platform

* Review comments
  • Loading branch information
zvecr authored Jan 8, 2021
1 parent b609a07 commit 6d9b4c7
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/newbs_getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,19 @@ We've tried to make QMK as easy to set up as possible. You only have to prepare

### ** 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

You will need to install MSYS2, Git and Python. Follow the installation instructions on https://www.msys2.org.
Expand All @@ -59,6 +72,8 @@ Install the QMK CLI by running:

python3 -m pip install qmk

</details>

### ** macOS **

QMK maintains a Homebrew tap and formula which will automatically install the CLI and all necessary dependencies.
Expand Down

0 comments on commit 6d9b4c7

Please sign in to comment.