summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatt Snell <msnell@unomaha.edu>2021-03-25 21:21:21 -0500
committerGitHub <noreply@github.com>2021-03-26 13:21:21 +1100
commitaa2b4a688b5f58bfa2818940c802659c2c1a1800 (patch)
tree24bb0ffb6e65f5d321f2038470df6da6773cb835
parent57475caab0c030dc3e37086fdc060ddf0c81e69f (diff)
[docs] Add IO Warning to WSL section of Getting Started (#12384)
* Add IO Warning to WSL section of Getting Started * FauxPark suggestion (thanks!) Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
-rw-r--r--docs/newbs_getting_started.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/newbs_getting_started.md b/docs/newbs_getting_started.md
index 3cb63e5692..7af9579dfb 100644
--- a/docs/newbs_getting_started.md
+++ b/docs/newbs_getting_started.md
@@ -70,6 +70,8 @@ Install the QMK CLI by running:
### ** Linux/WSL **
+?> **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).
+
#### Prerequisites
You 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: