sporq/kmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Clackety Keyboards Powered by Python
27 Commits 17 Branches 0 Tags 16 MiB
Python 99.1%
Makefile 0.6%
Dockerfile 0.2%
e26997d815
Go to file
Kyle Brown e26997d815 Fixed environment variables for ARDUINO. Added default, but will be overridden if set by the user
2018-09-03 17:32:42 -07:00
boards Use the new debug mode 2018-09-03 13:50:27 -07:00
entrypoints Teensy 3.1 support 2018-09-03 17:32:42 -07:00
kmk Move all remaining state into the single store, woot! 2018-09-03 15:21:34 -07:00
vendor Add micropython vendor 2018-09-03 17:32:42 -07:00
.gitignore Make builds a bit more robust and reusable 2018-09-03 01:23:15 -07:00
.gitmodules Teensy 3.1 support 2018-09-03 17:32:42 -07:00
BOARD_SETUP.md Add license and a very basic setup script I used to bootstrap the Feathers 2018-08-30 02:54:26 -07:00
LICENSE.md Add license and a very basic setup script I used to bootstrap the Feathers 2018-08-30 02:54:26 -07:00
Makefile Fixed environment variables for ARDUINO. Added default, but will be overridden if set by the user 2018-09-03 17:32:42 -07:00
Pipfile Niceties 2018-09-03 13:50:53 -07:00
Pipfile.lock Niceties 2018-09-03 13:50:53 -07:00
README.md Readme cleanup 2018-09-03 15:26:23 -07:00
setup.cfg More sane linter rules 2018-09-03 15:20:48 -07:00
upy-freeze.txt Add debug hooks to the event dispatcher, remove explicit prints 2018-09-03 13:50:12 -07:00

README.md

kmk_firmware

Mechanical keyboard firmware for humans (and ARM microcontrollers)

KMK is a work-in-progress and proof-of-concept firmware for (usually mechanical) keyboards, written in CircuitPython, a fork of MicroPython. This allows for high-level and expressive keyboard programming and creature comforts that C simply doesn't make easy. KMK was heavily inspired by QMK - in fact, KMK was only created because QMK didn't correctly support some hardware I bought, and hacking support in was going to be a heavy uphill battle.

This project is currently written and maintained by @klardotsh and @kdb424.

Supported Devices

Officially Supported

Support Planned/WIP

Unsupported Devices

If you don't see it in "Supported Devices", it won't work out of the box, it's basically that simple. Pull requests are welcome and encouraged to add support for new keyboards. The base requirements for device support are a port of CircuitPython or MicroPython, at least 256KB of flash storage, and USB and/or Bluetooth LE interfaces.

Devices require at least 256KB of flash to run KMK, and that's already pretty tight. This means that no AVR based microcontrollers are, or will ever be supported. This extends to Arduino-compatibles, including the Pro Micro. If you want to run custom firmware on your Pro Micro-equipped keyboard, or for that matter anything running the ATmega32U4 (Let's Split, Plancks before rev6, hundreds of others), check out QMK, the biggest influence of KMK by far. They're great people.

License, Copyright, and Legal

This project, and all source code within (even if the file is missing headers), is licensed GPLv3 - while the tl;dr is linked, the full license text is included in LICENSE.md at the top of this source tree.

When contributing for the first time, you'll need to sign a Contributor Licensing Agreement which is based on the Free Software Foundation's CLA. The CLA is basically a two-way promise that this code is and remains yours, but will be distributed as part of a larger GPLv3 project. If you'd like to get it out of the way early, you can find said CLA here. If you forget, the bots will remind you when you open the pull request, no worries!