top of page

Setup

Latest Update: 2022-05-07


Download Software 

Prepare Your Build Environment 

Run QMK Setup 

Test Your Build Environment

Download Software & Setup Folder


Mac & Win

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

  2. Download VHD - QMK firmware to Dev, and upzip

  3. Download nRF5_SDK to Dev, and unzip

  4. Download Visual Studio Code and install

  5. Download Python (Version 3) and Install

​

​

​

​

Wiki

Hardware

Software

​

QMK

​

Test

Support

Prepare Your Build Environment


Mac

  1. Open Terminal.app

  2. Install Homebrew - Copy and paste the command on Terminal: /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

  3. If you see the error like that: error: Not a valid ref: refs/remotes/origin/master. Copy and paste this command: rm -fr $(brew --repo homebrew/core) brew tap homebrew/core

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


Win

  1. Download MSYS64 (Zip, 1.4GB) and upzip to C:/


Linux

  1. Follow the guide from here

  2. After installed, if you can't make the keyboard hex file. Please try to downgrade the compiler version.


Guide for all OS 

https://docs.qmk.fm/#/newbs_getting_started

Run QMK Setup


Mac

  1. Run this command: qmk setup

  2. In most situations you will want to answer "y" and "Enter" to all of the prompts.


Win

We helped you setup already.

Test Your Build Environment


  1. Run: python3 --version, you should see: eg: Python 2.7 or Python 3.10

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

  3. 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)


Your qmk has been setup.


*If you see the error "/bin/sh: arm-none-eabi-gcc: command not found" on the Mac, Which means that the QMK is not installed completely.

Please try to run: qmk setup again.

bottom of page