readme.md

Quantum Mechanical Keyboard Firmware - chrislewisdev fork

Typing Speed -> RGB Animation Control

This fork of qmk_firmware contains the code I whipped up to make your keyboard's RGB animation speed match your typing speed. As of writing, this is a "first draft" version, aka the simplest implementation I could think of with the quickest/hackiest code. Beware hard-coding :)

Regardless, I'm happy to share the code and discuss improvements with anyone who'd like to contribute. I'll do my best to facilitate it in my spare time.

Getting Started

My original change amounts to several lines in quantum.h, quantum.c and rgblight.c. To see the details it's probably easiest if you look at this commit which contains all the changes.

I've created GitHub Issues for the most pressing things that need to be addressed before this could be merged into QMK - if you're interested in helping out, please do take a look!

To test it, I've just been using my DZ60 keyboard, building the firmware with make dz60:default and flashing with qmk_toolbox. If you're not familiar with how to do that, it's probably best you consult the QMK documentation.

Below is the original QMK readme:

QMK

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

• See the official documentation on docs.qmk.fm

The docs are hosted on Gitbook and GitHub (they are synced). You can request changes by making a fork and pull request, or by clicking the "suggest an edit" link on any page of the docs.

Supported Keyboards

• Planck
• Preonic
• ErgoDox EZ
• Clueboard
• Cluepad

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 Erez Zukerman, and the Clueboard by Zach White.

Official website

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