Go to file
Danny Nguyen 13e1388f2d Add nano switch pad 2017-11-01 20:02:52 -04:00
.vscode Add EditorConfig file (#1930) 2017-10-31 11:13:40 -04:00
docs Update getting_started_github.md 2017-11-01 14:10:28 -04:00
drivers update to driver separation 2017-09-15 21:43:58 -04:00
keyboards Add nano switch pad 2017-11-01 20:02:52 -04:00
layouts zweihander-osx: Remove app keys, etc. 2017-10-31 00:28:56 -04:00
lib Remove all Makefiles from the keyboards directory. (#1660) 2017-09-08 13:47:50 -04:00
quantum Fix Pointing Device code (#1934) 2017-10-31 11:13:00 -04:00
tests Fix unreferenced errors with mingw compiler and unit tests 2017-07-11 19:41:04 +03:00
tmk_core Adds .qmk file type as a target for QMK Toolbox (#1084) 2017-11-01 20:01:45 -04:00
users Creates a userspace for keymaps (#1559) 2017-10-21 11:44:11 -10:00
util hack to force new tag 2017-10-15 20:04:23 -04:00
.editorconfig Add EditorConfig file (#1930) 2017-10-31 11:13:40 -04:00
.gitattributes Set eep files to binary mode 2016-08-27 18:37:28 +03:00
.gitignore Adds .qmk file type as a target for QMK Toolbox (#1084) 2017-11-01 20:01:45 -04:00
.gitmodules Update uGFX and Chibios submodules + fixes (#1363) 2017-06-13 21:13:39 -07:00
.travis.yml add qmk.fm as a backup host 2017-10-15 13:37:46 -04:00
CODE_OF_CONDUCT.md create initial code of conduct 2017-06-27 21:36:44 -04:00
Dockerfile Reverting CMD Changes 2017-08-19 08:17:58 -04:00
Makefile add note to makefile for future use 2017-10-15 16:54:06 -04:00
Vagrantfile Update some obsolete references 2016-07-30 08:37:30 +02:00
autocomplete.sh Make arguments redo, subproject elimination (#1784) 2017-10-14 11:32:19 -10:00
book.json adds redirects for docs 2017-08-19 08:31:54 -04:00
build_full_test.mk Add SRC and OPT_DEFS when building tests 2017-07-20 10:17:31 -04:00
build_keyboard.mk Creates a userspace for keymaps (#1559) 2017-10-21 11:44:11 -10:00
build_layout.mk Creates a layouts/ folder for keymaps shared between keyboards (#1609) 2017-08-23 22:29:07 -04:00
build_test.mk Split common.mk into common.mk and common_features.mk 2017-06-18 21:22:22 +03:00
common.mk Start mvoing hardware drivers to /drivers/ (#1433) 2017-07-10 11:18:47 -04:00
common_features.mk Fix pointing device feature 2017-10-31 20:59:55 -04:00
lcd_backlight_keyframes.h Clarify naming between LCD_BACKLIGHT and LED_BACKLIGHT 2017-07-10 09:01:59 -04:00
license_GPLv2.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_GPLv3.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_Modified_BSD.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
message.mk Clone chibios and ugfx if it's not already checked out. (#1651) 2017-09-06 15:21:31 -07:00
readme.md Improvements to documentation (#1919) 2017-11-01 11:21:54 -04:00
secrets.tar.enc update building for .hex, secrets moving 2017-08-21 21:57:46 -04:00
shell.nix Add shell.nix for NixOS users 2017-09-25 13:14:20 -04:00
testlist.mk Add basic infrastrucure for building full tests 2017-06-18 21:08:23 +03:00

readme.md

Quantum Mechanical Keyboard Firmware

Current Version Build Status Gitter Docs Status GitHub contributors GitHub forks

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.

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.

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

Documentation

https://docs.qmk.fm is 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.