Environment Setup - Windows

To setup QMK we will need to use many UNIX utilities, however Windows is not an UNIX system. We will need to use an application called MSYS2 which packages many different utilities to give us an UNIX environment on Windows.

1.) Download and install MSYS2 from the official website.

Click the purple button below and simply follow through the steps in the installation section, come back when you are done.

Travel to msys2.org.

Once you are done with that, install git using this simple command:

	  pacman -S git
	

2.) Clone the modified version of QMK to MSYS2.

You will need to clone to the MSYS2 user directory, it generally is located in /c/msys64/home/[user]/. Modify the command below to get to that directory.

	  cd /c/msys64/home/[user]/
	

Once you are done with that and are in the correct directory, run this command to clone our modification of QMK. If you don't know what git is, it is an open source version control system which makes it easy for developers to collaborate and share source code with everyone. If you want to contribute to the project learning git is a great skill to have. However right now you don't need to know it.

	  git clone -b womier_k66 --recurse-submodules -j8 https://github.com/toastdb/qmk_firmware.git
	

3.) Installation of drivers and other necessary applications.

QMK includes a helpful script which installs all the different dependencies required to compile. First we will need to go into the cloned qmk_firmware directory.

	  cd qmk_firmware/
	

That was easy enough, now we need to run the script.

	  ./util/qmk_install.sh
	

When this is fully complete and has no errors, you will need to exit out of MSYS MinGW and open it back up again to reload. This might take a bit. Go back to the MSYS2 home directory and from there go into the qmk_firmware directory. Once this is done move on to the next page by pressing the purple button below.