Skip to content

gamaPhy/qmk-keyboards

Repository files navigation

qmk-keyboards

This repository contains the code and binaries for our keypads/keyboards based on QMK.

Latest Firmware

The most recent firmware for every keypad/keyboard is in the latest release of this repository.

Development Usage

Getting Started

  1. Setup QMK environment: https://docs.qmk.fm/#/newbs_getting_started
  2. git clone https://github.com/gamaPhy/qmk-keyboards.git --recurse-submodules

Workflow

The in_qmk.sh script takes any command as an argument, and then runs that command in a QMK environment that has access to the keyboards in firmware/. These keyboards are inside the gamaphy directory in the QMK environment. So to build firmware for Freedom (3k) that supports VIA, you could run:

./in_qmk.sh qmk compile -kb gamaphy/freedom/3k -km via

And to flash, you could run:

./in_qmk.sh qmk flash -kb gamaphy/freedom/3k -km via

It is suggested to use the qmk commands instead of make commands, since interrupting a make command will mess up the files in the qmk_firmware submodule.