aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJoel Challis <git@zvecr.com>2021-01-08 19:09:28 +0000
committerGitHub <noreply@github.com>2021-01-08 11:09:28 -0800
commit6d9b4c7b4f5de5631955e57b9706f90072971bcb (patch)
treeb9c6088d9f0d9d96c68b818cc6b255279fa318b7 /docs
parentb609a07b45ccb1954054f85b8fdd53e03c76de90 (diff)
downloadqmk_firmware-6d9b4c7b4f5de5631955e57b9706f90072971bcb.tar.gz
qmk_firmware-6d9b4c7b4f5de5631955e57b9706f90072971bcb.zip
Suggest 'QMK MSYS' as the default windows platform (#11321)
* Suggest 'QMK MSYS' as the default windows platform * Review comments
Diffstat (limited to 'docs')
-rw-r--r--docs/newbs_getting_started.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/newbs_getting_started.md b/docs/newbs_getting_started.md
index 4609275d0..e03562f00 100644
--- a/docs/newbs_getting_started.md
+++ b/docs/newbs_getting_started.md
@@ -41,6 +41,19 @@ We've tried to make QMK as easy to set up as possible. You only have to prepare
41 41
42### ** Windows ** 42### ** Windows **
43 43
44QMK 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.
45
46#### Prerequisites
47
48You will need to install `QMK MSYS`. The latest release is available at https://msys.qmk.fm/.
49
50Alternatively, if you'd like to manually install msys2, the following section will walk you through the process.
51
52<details>
53 <summary>Manual Install</summary>
54
55?> Ignore the following steps if you use `QMK MSYS`.
56
44#### Prerequisites 57#### Prerequisites
45 58
46You will need to install MSYS2, Git and Python. Follow the installation instructions on https://www.msys2.org. 59You 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:
59 72
60 python3 -m pip install qmk 73 python3 -m pip install qmk
61 74
75</details>
76
62### ** macOS ** 77### ** macOS **
63 78
64QMK maintains a Homebrew tap and formula which will automatically install the CLI and all necessary dependencies. 79QMK maintains a Homebrew tap and formula which will automatically install the CLI and all necessary dependencies.