]> git.donarmstrong.com Git - qmk_firmware.git/blob - BUILD_GUIDE.md
Added placeholder for windows section of build guide
[qmk_firmware.git] / BUILD_GUIDE.md
1 # Build Guide
2
3 ## Build Environment Setup
4
5 ### Windows
6 What these instructions look like depends on whether NoahAndrews's setup scripts get merged
7
8 ### Mac
9
10
11 ### Linux
12
13 ### Vagrant
14 If you have any problems building the firmware, you can try using a tool called Vagrant. It will set up a virtual computer with a known configuration that's ready-to-go for firmware building. OLKB does NOT host the files for this virtual computer. Details on how to set up Vagrant are in the [VAGRANT_GUIDE file](VAGRANT_GUIDE.md).