This repository has been archived on 2025-01-28. You can view files and clone it, but cannot push or open issues or pull requests.
Seebs c0baf2a964 Improve state/chord handling and clean up namespace
Some values that can never, ever, change were held in local
variables, rather than in PROGMEM. Fixed.

Change "pressed" to a signed int so the test for < 0 makes
sense, and to avoid possible weird failure modes in the
case where a key release comes in when pressed is already
zero. (Shouldn't happen, sure, but computers are weird.)

A lot of things in process_steno had external linkage for no
particular reason. They've been marked static. Stuff still
builds.

Distinguish between currently-held keys and keys that have
been held, and expose these values through a nicely-named API
so other code could, say, check on the current set of steno
chording in order to make displays. Also in passing fix up the
"state" value having external linkage so it could clash with
other people's variable declarations.

The API also provides hooks for key processing and steno chord
events, so you can monitor those events without having to
run in matrix_scan_user and recheck the values directly. Also
document these.

There is no path through processing a key that doesn't
end with a return false, so the nested return foo() are
gone and we just return false.
2018-04-07 17:12:44 -04:00
..
2017-09-06 14:49:19 -07:00
2018-03-26 11:43:37 -07:00
2017-12-09 10:46:11 -05:00
2018-03-25 16:44:17 -07:00
2017-12-09 10:46:11 -05:00
2017-12-09 10:46:11 -05:00
2017-12-09 10:46:11 -05:00
2018-03-01 07:45:47 -08:00
2017-12-09 10:46:11 -05:00
2018-03-28 16:55:58 -04:00
2017-12-09 10:46:11 -05:00
2017-12-09 10:46:11 -05:00
2017-12-09 10:46:11 -05:00
2017-12-09 10:46:11 -05:00
2017-12-09 10:46:11 -05:00
2017-12-09 10:46:11 -05:00
2017-12-09 10:46:11 -05:00
2017-12-09 10:46:11 -05:00
2018-03-25 16:44:17 -07:00
2018-03-06 15:39:46 -08:00
2017-12-09 10:46:11 -05:00
2017-12-09 10:46:11 -05:00
2017-12-09 10:46:11 -05:00
2018-03-01 07:45:47 -08:00
2017-12-09 10:46:11 -05:00

Quantum Mechanical Keyboard Firmware

What is QMK Firmware?

QMK (Quantum Mechanical Keyboard) is an open source community that maintains QMK Firmware, QMK Flasher, qmk.fm, and these docs. QMK Firmware is a keyboard firmware based on the tmk_keyboard with some useful features for Atmel AVR controllers, and more specifically, the OLKB product line, the ErgoDox EZ keyboard, and the Clueboard product line. It has also been ported to ARM chips using ChibiOS. You can use it to power your own hand-wired or custom keyboard PCB.

How to Get It

If you plan on contributing a keymap, keyboard, or features to QMK, the easiest thing to do is fork the repo through Github, and clone your repo locally to make your changes, push them, then open a Pull Request from your fork.

Otherwise, you can either download it directly (zip, tar), or clone it via git (git@github.com:qmk/qmk_firmware.git), or https (https://github.com/qmk/qmk_firmware.git).

How to Compile

Before you are able to compile, you'll need to install an environment for AVR or/and ARM development. Once that is complete, you'll use the make command to build a keyboard and keymap with the following notation:

make planck/rev4:default

This would build the rev4 revision of the planck with the default keymap. Not all keyboards have revisions (also called subprojects or folders), in which case, it can be omitted:

make preonic:default

How to Customize

QMK has lots of features to explore, and a good deal of reference documentation to dig through. Most features are taken advantage of by modifying your keymap, and changing the keycodes.