No description

Find a file

Graham P Heath 9b82a9295f [Docs] Add note about using Unicode Hex Input (#5248 ) * Add note about using Unicode Hex Input * Update docs * remove extra return, oops		2019-02-28 12:15:38 -08:00
.github	Tweak issue templates (capitalisation mostly) (#5133 )	2019-02-14 20:44:27 -08:00
.vscode
docs	[Docs] Add note about using Unicode Hex Input (#5248 )	2019-02-28 12:15:38 -08:00
drivers	Haptic feedback generalized - DRV2605 and solenoids (#4939 )	2019-02-16 18:39:30 -08:00
keyboards	[Keyboard] GH60 Satan improvements (#5264 )	2019-02-28 12:06:26 -08:00
layouts	[Keymap] Userspace Keymap Updates (#5215 )	2019-02-28 11:37:34 -08:00
lib
quantum	Ask for your name when generating a new keyboard (#5214 )	2019-02-26 07:59:34 -08:00
tests	Remove empty action_function()	2019-01-11 18:32:43 -08:00
tmk_core	Velocikey: Match RGB animation speed to typing speed (#3754 )	2019-02-21 07:22:46 -08:00
users	[Keymap] Cleaning up my config and userspace files (#5265 )	2019-02-28 12:02:22 -08:00
util	Ask for your name when generating a new keyboard (#5214 )	2019-02-26 07:59:34 -08:00
.clang-format	Add .clang-format file	2019-02-17 08:59:19 -08:00
.clang_complete
.editorconfig
.gitattributes
.gitignore	Add Satisfaction75 to QMK, Enable EEPROM on stm32f072 (#5094 )	2019-02-13 08:03:26 -08:00
.gitmodules
.travis.yml	Remove AUTOGEN and fix Travis Compiled Push scripts (#5077 )	2019-02-12 16:46:04 -08:00
autocomplete.sh
book.json
bootloader.mk
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
common.mk	Move Split Common VPATH addition (#4716 )	2018-12-31 08:45:44 -08:00
common_features.mk	Velocikey: Match RGB animation speed to typing speed (#3754 )	2019-02-21 07:22:46 -08:00
Dockerfile
Doxyfile
doxygen-todo
LICENSE
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
Makefile	Add distclean target instead	2019-02-05 09:49:24 -08:00
message.mk
readme.md
secrets.tar.enc
shell.nix
show_options.mk	Add makefile target 'show_build_options' and 'show_all_features' (#5048 )	2019-02-14 17:52:58 -08:00
testlist.mk
Vagrantfile	Initial fixes for vagrant (#4900 )	2019-01-21 10:24:43 -08: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.