Go to file
fauxpark 5edd4b99fe [Docs] Encourage newbs to not download the repo as a zip (#7353)
* Encourage newbs to not download the repo as a zip

* Tweak wording and remove Russian translation of deprecated Vista+ instructions
2019-11-14 11:37:18 -08:00
.github [GitHub] Update issue templates (#7303) 2019-11-08 20:09:54 -08:00
.vscode Generalize Tap Dance Layer functions (#6629) 2019-09-21 11:22:27 -07:00
bin Fix "could not find module" error message formatting (#7219) 2019-10-30 22:50:45 -07:00
docs [Docs] Encourage newbs to not download the repo as a zip (#7353) 2019-11-14 11:37:18 -08:00
drivers Unify RGB and RGBW commands (#7297) 2019-11-09 15:51:39 +00:00
keyboards [Keyboard] Add TG4x (#7351) 2019-11-14 10:52:55 -08:00
layouts [Keymap] Add issmirnov {user, ergodox, levinson} files. (#7239) 2019-11-08 19:17:21 -08:00
lib format code according to conventions [skip ci] 2019-11-13 05:24:56 +00:00
quantum disable deprecated actions (#7211) 2019-11-12 13:27:20 +11:00
tests
tmk_core Fix chibios when mouse and nkro disabled (#7312) 2019-11-10 09:02:46 -08:00
users [Keymap] Added Xulkal ALT Keymap (#7332) 2019-11-12 23:02:58 -08:00
util Update ARM GCC on macOS to 8.3 (#7318) 2019-11-13 10:13:27 -08:00
.clang-format
.clang_complete
.editorconfig
.gitattributes
.gitignore [Docs] Update hand wire guide (#7044) 2019-10-25 11:48:59 -07:00
.gitmodules
.travis.yml CI - Fix change detection (#7038) 2019-11-04 16:18:57 -08:00
CODE_OF_CONDUCT.md
Dockerfile Update docker util script and travis to use new base container 2019-07-14 21:01:38 -07:00
Doxyfile
LICENSE add an explicit lisence file for github to pickup 2017-11-13 20:50:54 -05:00
Makefile Set `git submodule update` depth to 50 (#7269) 2019-11-05 11:50:18 -08:00
Vagrantfile Configure Vagrant to use qmk_base_container (#6194) 2019-07-16 01:20:34 -07:00
autocomplete.sh
book.json adds redirects for docs 2017-08-19 08:31:54 -04:00
bootloader.mk Update bootloader.mk (#6698) 2019-09-18 09:48:58 +10:00
build_full_test.mk
build_json.mk Make generating keymap.c from JSON more reliable 2019-11-12 20:37:28 -08:00
build_keyboard.mk
build_layout.mk
build_test.mk
common.mk
common_features.mk [Core] Convert Dynamic Macro to a Core Feature (#5948) 2019-11-04 22:59:13 -08:00
doxygen-todo
license_GPLv2.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_GPLv3.md
license_Modified_BSD.md
message.mk Add list-keymaps make target (#5563) 2019-09-21 00:00:58 -07:00
nose2.cfg Setup a python test framework 2019-09-07 07:58:41 -07:00
readme.md [Docs] Fix missing link in readme (#6958) 2019-10-08 21:59:11 -07:00
requirements.txt Add cli convert subcommand, from raw KLE to JSON (#6898) 2019-11-12 20:55:41 -08:00
secrets.tar.enc
setup.cfg
shell.nix add python3 to shell.nix (#6774) 2019-09-21 11:59:18 -07:00
show_options.mk Add Dip Switch as a core feature (#6140) 2019-09-03 08:34:31 -07:00
testlist.mk

readme.md

Quantum Mechanical Keyboard Firmware

Current Version Build Status Discord 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.

Documentation

The docs are powered by Docsify and hosted on GitHub. You can request changes by making a fork and pull request, or by clicking the "Edit Document" link at the bottom of any page.

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

Official Website

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