Go to file

swampmonster b23eeb6a14 Documentation update (#12484 ) Update documentation to reflect what the actual target flags are Co-authored-by: swampmonster <>		2021-04-11 12:49:12 +02:00
.github	…
.vscode	…
api_data	…
bin	…
data	Add support for qmk_configurator style aliases (#11954 )	2021-03-24 09:26:38 -07:00
docs	Documentation update (#12484 )	2021-04-11 12:49:12 +02:00
drivers	…
keyboards	Update readme.md (#12502 )	2021-04-11 12:46:43 +02:00
layouts	[Keymap] stanrc85 keymap updates (#12184 )	2021-03-16 19:44:13 -07:00
lib	`qmk chibios-confmigrate`: Make `-i` and `-r` required (#12515 )	2021-04-08 14:16:15 +10:00
nix	[nix] Use niv and poetry2nix to more easily manage dependencies (#11181 )	2021-04-03 08:05:46 -07:00
platforms/chibios	…
quantum	fix line endings	2021-04-03 08:27:46 -07:00
tests	…
tmk_core	Format code according to conventions (#12540 )	2021-04-10 17:34:26 +01:00
users	[Keymap] Remove LAYOUT_kc macros from edvorakjp keymaps (#12217 )	2021-04-09 17:37:49 -07:00
util	…
.clang-format	…
.editorconfig	…
.gitattributes	[nix] Use niv and poetry2nix to more easily manage dependencies (#11181 )	2021-04-03 08:05:46 -07:00
.gitignore	…
.gitmodules	…
.travis.yml	…
CODE_OF_CONDUCT.md	…
Dockerfile	…
Doxyfile	…
LICENSE	…
Makefile	…
Vagrantfile	…
book.json	…
bootloader.mk	…
build_full_test.mk	…
build_json.mk	…
build_keyboard.mk	…
build_layout.mk	…
build_test.mk	…
common.mk	…
common_features.mk	…
disable_features.mk	…
doxygen-todo	…
license_GPLv2.md	…
license_GPLv3.md	…
license_Modified_BSD.md	…
message.mk	…
nose2.cfg	…
readme.md	…
requirements-dev.txt	Remove `wave` from requirements-dev.txt (#12387 )	2021-04-03 09:15:39 -07:00
requirements.txt	…
secrets.tar.enc	…
setup.cfg	…
shell.nix	[nix] Use niv and poetry2nix to more easily manage dependencies (#11181 )	2021-04-03 08:05:46 -07:00
show_options.mk	…
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 powered by Docsify and hosted on GitHub. They are also viewable offline; see Previewing the Documentation for more details.

You can request changes by making a fork and opening a pull request, or by clicking the "Edit this page" 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.