You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Go to file

zvecr 0a03f7cff7 Update docker util script and travis to use new base container		6 years ago
.github	Tweak issue templates (capitalisation mostly) (#5133 )	7 years ago
.vscode	…
docs	[Docs] Fix indented subheading on faq_debug.md (#6320 )	6 years ago
drivers	Use QUANTUM_LIB_SRC for i2c_master.c inclusion (#5617 )	7 years ago
keyboards	[Keymap] Fix Comment Styling (#6324 )	6 years ago
layouts	[Keymap] jotix ortho_4x12 layout match new keycaps (#6209 )	7 years ago
lib	Spirals, Pinwheels, and Documentation....Oh My! RGB Matrix Effects (#5877 )	7 years ago
quantum	Switching rgb_config_t to use HSV struct	7 years ago
tests	Remove empty action_function()	7 years ago
tmk_core	Display firmware size percentage (#6307 )	7 years ago
users	Switching rgb_config_t to use HSV struct	7 years ago
util	Update docker util script and travis to use new base container	6 years ago
.clang-format	fix indent size	7 years ago
.clang_complete	…
.editorconfig	Add makeful rules to .editorconfig	7 years ago
.gitattributes	…
.gitignore	Ignore VSCode ipsh folder (#5741 )	7 years ago
.gitmodules	…
.travis.yml	Update docker util script and travis to use new base container	6 years ago
CODE_OF_CONDUCT.md	…
Dockerfile	Update docker util script and travis to use new base container	6 years ago
Doxyfile	…
LICENSE	…
Makefile	Make python a required build dependency (#5784 )	7 years ago
Vagrantfile	Update run command now that the install script is unattended, fix mount point for Debian (#5847 )	7 years ago
autocomplete.sh	…
book.json	…
bootloader.mk	…
build_full_test.mk	…
build_keyboard.mk	Fix LIB_SRC insert position (#5731 )	7 years ago
build_layout.mk	Add a mechanism for force building a particular community layout (#5027 )	7 years ago
build_test.mk	…
common.mk	Move Split Common VPATH addition (#4716 )	7 years ago
common_features.mk	Use QUANTUM_LIB_SRC for i2c_master.c inclusion (#5617 )	7 years ago
doxygen-todo	…
license_GPLv2.md	…
license_GPLv3.md	…
license_Modified_BSD.md	…
message.mk	Display firmware size percentage (#6307 )	7 years ago
readme.md	Removes Erez personally from QMK (#5883 )	7 years ago
secrets.tar.enc	…
shell.nix	shell.nix: Packages relocated in upstream cleanup	7 years ago
show_options.mk	Add option to enable LTO easily (#5674 )	7 years ago
testlist.mk	…

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 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.