Download Software

Mac & Window

1. Create new folder: Users>[your user name]>Dev

2. Download Visual Studio Code

3. Download VHD - QMK firmware to Dev

4. Download nRF5_SDK to Dev, and unzip

Prepare Your Build Environment

Mac - easy and fast

1. Open Terminal.app

2. Install Homebrew - Run command on Terminal

3. Run this command: brew install qmk/qmk/qmk

4. Install python3

Window - You will need to install MSYS2, Git, and the QMK CLI.

1. Install MSYS2

2. Run this command: pacman --needed --noconfirm --disable-download-timeout -S git mingw-w64-x86_64-toolchain mingw-w64-x86_64-python3-pip python3 -m pip install qmk

3. Install python3

Run QMK Setup

Run this command: qmk setup

Test Your Build Environment

1. Run this command for testing: qmk compile -kb clueboard/66/rev3 -km default

2. When it is done you should have a lot of output that ends similar to this: 

Linking: .build/clueboard_66_rev3_default.elf  [OK] 

Creating load file for flashing: .build/clueboard_66_rev3_default.hex  [OK] 

Copying clueboard_66_rev3_default.hex to qmk_firmware folder   [OK] 

Checking file size of clueboard_66_rev3_default.hex   [OK]

* The firmware size is fine - 26356/28672 (2316 bytes free)