From 6aa3546a769c409c90de06e6455a3dffbdaa7d9d Mon Sep 17 00:00:00 2001 From: zvecr Date: Mon, 25 Jan 2021 19:37:45 +0000 Subject: [PATCH] Split out WSL setup and point to 'QMK WSL' distro --- docs/newbs_getting_started.md | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/docs/newbs_getting_started.md b/docs/newbs_getting_started.md index 7af9579dfba..29505de0c13 100644 --- a/docs/newbs_getting_started.md +++ b/docs/newbs_getting_started.md @@ -68,7 +68,7 @@ Install the QMK CLI by running: brew install qmk/qmk/qmk -### ** Linux/WSL ** +### ** Linux ** ?> **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). @@ -102,6 +102,20 @@ You can also try the `qmk-git` package from AUR: yay -S qmk-git +### ** WSL ** + +QMK maintains a WSL distro with the CLI and all necessary dependencies. + +Alternatively, if you'd like to manually install against the WSL distro of your choice, follow the `Linux` part of this guide after installing WSL. + +#### Prerequisites + +You will need to install WSL. Follow the instructions [here](https://docs.microsoft.com/en-us/windows/wsl/install-win10). + +#### Installation + +You will need to install the `QMK WSL` distro. The latest release is available at . + ### ** FreeBSD ** #### Prerequisites @@ -140,7 +154,7 @@ After installing QMK you can set it up with this command: In most situations you will want to answer `y` to all of the prompts. -### ** Linux/WSL ** +### ** Linux ** After installing QMK you can set it up with this command: @@ -154,6 +168,15 @@ This is due to a [bug](https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=839155) Sadly, Ubuntu reitroduced this bug and is [yet to fix it](https://bugs.launchpad.net/ubuntu/+source/bash/+bug/1588562). Luckily, the fix is easy. Run this as your user: `echo 'PATH="$HOME/.local/bin:$PATH"' >> $HOME/.bashrc && source $HOME/.bashrc` + +### ** WSL ** + +After installing QMK you can set it up with this command: + + qmk setup + +In most situations you will want to answer `y` to all of the prompts. + ### ** FreeBSD ** After installing QMK you can set it up with this command: