No description

Find a file

skullydazed 068571b9fe Update our style guide (#5500 ) * Update our style guide * Clarify muiltple condition ifs * update the ifdef section		2019-04-18 15:59:51 -07:00
.github	Tweak issue templates (capitalisation mostly) (#5133 )	2019-02-14 20:44:27 -08:00
.vscode	Xton's first keymap! (#2941 )	2018-05-12 08:52:11 -07:00
docs	Update our style guide (#5500 )	2019-04-18 15:59:51 -07:00
drivers	Features/ws2812 matrix driver (#5418 )	2019-04-14 17:50:35 -07:00
keyboards	[Keyboard] Update Tetris (#5513 )	2019-04-18 15:37:26 -07:00
layouts	RGB Matrix Overhaul (#5372 )	2019-04-02 17:24:14 -07:00
lib	RGB Matrix Overhaul (#5372 )	2019-04-02 17:24:14 -07:00
quantum	[core] Fix for eager_pr #5643	2019-04-18 15:45:36 -07:00
tests	Remove empty action_function()	2019-01-11 18:32:43 -08:00
tmk_core	Fix wake from suspend LED functionality	2019-04-18 11:55:45 -07:00
users	Xulkal Keymaps	2019-04-16 18:30:54 -07:00
util	Add vendor and product arguments to atmega32a_program.py - fix hex print	2019-04-12 14:04:40 -07:00
.clang-format	Update our style guide (#5500 )	2019-04-18 15:59:51 -07:00
.clang_complete	Vim Layout for Ergodox-EZ (mac only) (#2112 )	2017-12-11 21:06:05 -05:00
.editorconfig	Update our style guide (#5500 )	2019-04-18 15:59:51 -07:00
.gitattributes
.gitignore	Add Satisfaction75 to QMK, Enable EEPROM on stm32f072 (#5094 )	2019-02-13 08:03:26 -08:00
.gitmodules	Update .gitmodules	2017-11-16 15:09:45 -05:00
.travis.yml	Apply MAKEFLAGS to speed up CI	2019-04-12 13:38:59 -07:00
autocomplete.sh
book.json
bootloader.mk	Add Teensy ++ 2.0 bootloader support	2018-05-08 20:08:17 -04:00
build_full_test.mk
build_keyboard.mk	Add a mechanism for force building a particular community layout (#5027 )	2019-02-14 20:14:26 -08:00
build_layout.mk	Add a mechanism for force building a particular community layout (#5027 )	2019-02-14 20:14:26 -08:00
build_test.mk
CODE_OF_CONDUCT.md	Update CODE_OF_CONDUCT.md	2018-08-01 15:20:02 -04:00
common.mk	Move Split Common VPATH addition (#4716 )	2018-12-31 08:45:44 -08:00
common_features.mk	Features/ws2812 matrix driver (#5418 )	2019-04-14 17:50:35 -07:00
Dockerfile	Revert "Update build instructions and docker file to download submodules" (#5533 )	2019-04-10 14:15:51 -07:00
Doxyfile	Generate API docs from source code comments (#2491 )	2018-03-22 02:50:38 -04:00
doxygen-todo	Generate API docs from source code comments (#2491 )	2018-03-22 02:50:38 -04:00
LICENSE
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
Makefile	Shallow clone submodules. (#5279 )	2019-03-08 07:58:40 -08:00
message.mk	build size-check enhancement (#5485 )	2019-03-27 08:51:56 -07:00
readme.md	Add Atreus as an official board.	2018-08-16 12:01:34 -04:00
secrets.tar.enc
shell.nix	shell.nix: Packages relocated in upstream cleanup	2018-12-22 15:09:58 -08:00
show_options.mk	Clean up debounce a bit (#5255 )	2019-03-04 07:44:46 -08:00
testlist.mk
Vagrantfile	Align docker and vagrant base images (#4905 )	2019-03-17 10:36:59 -07:00

readme.md

Quantum Mechanical Keyboard Firmware

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

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, the Clueboard by Zach White, and the Atreus by Phil Hagelberg.

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.