Skip to content

Latest commit

 

History

History
57 lines (34 loc) · 3.17 KB

readme.md

File metadata and controls

57 lines (34 loc) · 3.17 KB

Quantum Mechanical Keyboard Firmware

Current Version Discord Docs Status GitHub contributors GitHub forks

This is a keyboard firmware based on the tmk_keyboard firmware with some useful features for Atmel AVR and ARM controllers, and more specifically, the OLKB product line, the ErgoDox EZ keyboard, and the Clueboard product line.

Documentation

The docs are powered by Docsify and hosted on GitHub. They are also viewable offline; see Previewing the Documentation for more details.

You can request changes by making a fork and opening a pull request, or by clicking the "Edit this page" link at the bottom of any page.

Supported Keyboards

The project also includes community support for lots of other keyboards.

Maintainers

QMK is developed and maintained by Jack Humbert of OLKB with contributions from the community, and of course, Hasu. The OLKB product firmwares are maintained by Jack Humbert, the Ergodox EZ by ZSA Technology Labs, the Clueboard by Zach White, and the Atreus by Phil Hagelberg.

Official Website

qmk.fm is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.

This Fork

For questions, contact me on Discord matthijsboog#5156

The first time you flash this code press the reset button on the pcb twice. Then it will show up as a drive on your pc where you can paste the .uf2 file.

After that, just hold escape while plugging it in or use the reset combination (fn + Lctrl).

Be aware that this is a work in progress and has mostly been aimed at the "default" keymap. Update: "via" is working as well now, just make sure to select "Use v2 definitions" before loading the .json in the Design tab.

To compile:

Clone this repo with "git clone MattBoog/qmk_matt_fk680 --recurse-submodules --remote-submodules"

Run "git submodule update --init"

Set this repo as your qmk location in qmk msys using "qmk setup -H [filepath]"

Then type "qmk compile -kb zhaqian/fk680 -km default"