aboutsummaryrefslogtreecommitdiff
path: root/docs/getting_started_build_tools.md
diff options
context:
space:
mode:
authorfauxpark <fauxpark@gmail.com>2017-12-09 16:36:32 +1100
committerJack Humbert <jack.humb@gmail.com>2017-12-09 10:46:11 -0500
commit7b0356d1d49da6574570e110f61f95692afdb3d0 (patch)
treea3e70802085ea8089f1e7851529f0296247fa264 /docs/getting_started_build_tools.md
parent6eb89ae906db7f226570e1839b88dcdd3a8fa962 (diff)
downloadqmk_firmware-7b0356d1d49da6574570e110f61f95692afdb3d0.tar.gz
qmk_firmware-7b0356d1d49da6574570e110f61f95692afdb3d0.zip
Convert all headings to Title Case
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 88612ff56..2a682032a 100644
--- a/docs/getting_started_build_tools.md
+++ b/docs/getting_started_build_tools.md
@@ -82,7 +82,7 @@ You will need to clone the repository to your Windows file system using the norm
82 82
83Once 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. 83Once 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.
84 84
85### Toolchain setup 85### Toolchain Setup
86The 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. 86The 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.
87 87
881. Open "Bash On Ubuntu On Windows" from the start menu. 881. Open "Bash On Ubuntu On Windows" from the start menu.
@@ -91,13 +91,13 @@ The Toolchain setup is done through the Windows Subsystem for Linux, and the pro
914. Close the Bash command window, and re-open it. 914. Close the Bash command window, and re-open it.
925. You are ready to compile and flash the firmware! 925. You are ready to compile and flash the firmware!
93 93
94### Some important things to keep in mind 94### Some Important Things to Keep in Mind
95* You can run `util/wsl_install.sh` again to get all the newest updates. 95* You can run `util/wsl_install.sh` again to get all the newest updates.
96* Your QMK repository need to be on a Windows file system path, since WSL can't run executables outside it. 96* Your QMK repository need to be on a Windows file system path, since WSL can't run executables outside it.
97* The WSL Git is **not** compatible with the Windows Git, so use the Windows Git Bash or a windows Git GUI for all Git operations 97* The WSL Git is **not** compatible with the Windows Git, so use the Windows Git Bash or a windows Git GUI for all Git operations
98* You can edit files either inside WSL or normally using Windows, but note that if you edit makefiles or shell scripts, make sure you are using an editor that saves the files with Unix line endings. Otherwise the compilation might not work. 98* You can edit files either inside WSL or normally using Windows, but note that if you edit makefiles or shell scripts, make sure you are using an editor that saves the files with Unix line endings. Otherwise the compilation might not work.
99 99
100## Windows (Vista and later) (Deprecated) 100## Windows (Vista and Later) (Deprecated)
101 101
102These are the old instructions for Windows Vista and later. We recommend you use [MSYS2 as outlined above](#windows-with-msys2-recommended). 102These are the old instructions for Windows Vista and later. We recommend you use [MSYS2 as outlined above](#windows-with-msys2-recommended).
103 103