summaryrefslogtreecommitdiffstats
path: root/docs/getting_started_build_tools.md
diff options
context:
space:
mode:
authorfauxpark <fauxpark@gmail.com>2017-12-09 06:56:58 +0100
committerJack Humbert <jack.humb@gmail.com>2017-12-09 16:46:11 +0100
commitbb53635f33c213e5a940edea8b07026ef89aed42 (patch)
tree7e170b424e37b7305f8be3072cd8c970f77ca073 /docs/getting_started_build_tools.md
parentaf37bb2f78c39c224c995eb57c757c63034a3d9c (diff)
downloadqmk_firmware-bb53635f33c213e5a940edea8b07026ef89aed42.tar.gz
qmk_firmware-bb53635f33c213e5a940edea8b07026ef89aed42.tar.xz
Trim trailing whitespace
Diffstat (limited to 'docs/getting_started_build_tools.md')
-rw-r--r--docs/getting_started_build_tools.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/getting_started_build_tools.md b/docs/getting_started_build_tools.md
index cd92ed68a..6c8eca0de 100644
--- a/docs/getting_started_build_tools.md
+++ b/docs/getting_started_build_tools.md
@@ -78,15 +78,15 @@ In addition to the Creators Update, you need Windows 10 Subystem for Linux, so i
### Git
If you already have cloned the repository on your Windows file system you can ignore this section.
-You will need to clone the repository to your Windows file system using the normal Git for Windows and **not** the WSL Git. So if you haven't installed Git before, [download](https://git-scm.com/download/win) and install it. Then [set it up](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup), it's important that you setup the e-mail and user name, especially if you are planning to contribute.
+You will need to clone the repository to your Windows file system using the normal Git for Windows and **not** the WSL Git. So if you haven't installed Git before, [download](https://git-scm.com/download/win) and install it. Then [set it up](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup), it's important that you setup the e-mail and user name, especially if you are planning to contribute.
Once Git is installed, open the Git Bash command and change the directory to where you want to clone QMK; note that you have to use forward slashes, and that your c drive is accessed like this `/c/path/to/where/you/want/to/go`. Then run `git clone --recurse-submodules https://github.com/qmk/qmk_firmware`, this will create a new folder `qmk_firmware` as a subfolder of the current one.
### Toolchain Setup
The Toolchain setup is done through the Windows Subsystem for Linux, and the process is fully automated. If you want to do everything manually, there are no other instructions than the scripts themselves, but you can always open issues and ask for more information.
-1. Open "Bash On Ubuntu On Windows" from the start menu.
-2. Go to the directory where you cloned `qmk_firmware`. Note that the paths start with `/mnt/` in the WSL, so you have to write for example `cd /mnt/c/path/to/qmk_firmware`.
+1. Open "Bash On Ubuntu On Windows" from the start menu.
+2. Go to the directory where you cloned `qmk_firmware`. Note that the paths start with `/mnt/` in the WSL, so you have to write for example `cd /mnt/c/path/to/qmk_firmware`.
3. Run `util/wsl_install.sh` and follow the on-screen instructions.
4. Close the Bash command window, and re-open it.
5. You are ready to compile and flash the firmware!