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

Hawley Waldman 98939868fa Update github instruction link in newbs_getting_started.md (#12510 ) Clarify that the link to the github/forking instructions is a link to how to fork this project. Previous wording implied that the link was to a how-to-use github in general page.		5 years ago
.github	fix CI job: api-data->api_data	5 years ago
.vscode	…
api_data	…
bin	…
data	Add support for qmk_configurator style aliases (#11954 )	5 years ago
docs	Update github instruction link in newbs_getting_started.md (#12510 )	5 years ago
drivers	Merge branch 'master' into develop	5 years ago
keyboards	Reverse K0E and K0G (#12491 )	5 years ago
layouts	[Keymap] stanrc85 keymap updates (#12184 )	5 years ago
lib	`qmk chibios-confmigrate`: Make `-i` and `-r` required (#12515 )	5 years ago
nix	[nix] Use niv and poetry2nix to more easily manage dependencies (#11181 )	5 years ago
platforms/chibios	…
quantum	fix line endings	5 years ago
tests	…
tmk_core	Format code according to conventions (#12540 )	5 years ago
users	[Keymap] Remove LAYOUT_kc macros from edvorakjp keymaps (#12217 )	5 years ago
util	Add support for using podman to util/docker_build.sh (#10819 )	5 years ago
.clang-format	…
.editorconfig	…
.gitattributes	[nix] Use niv and poetry2nix to more easily manage dependencies (#11181 )	5 years ago
.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	`qmk generate-rules-mk`: add `--escape` switch for makefile logic (#12101 )	5 years ago
build_layout.mk	…
build_test.mk	…
common.mk	…
common_features.mk	Extract sendstring into its own compilation unit (#12060 )	5 years ago
disable_features.mk	…
doxygen-todo	…
license_GPLv2.md	…
license_GPLv3.md	…
license_Modified_BSD.md	…
message.mk	…
nose2.cfg	…
readme.md	2021 February 27 Breaking Changes Changelog (#11975 )	5 years ago
requirements-dev.txt	Remove `wave` from requirements-dev.txt (#12387 )	5 years ago
requirements.txt	Enforce minimum versions for jsonschema and MILC (#12141 )	5 years ago
secrets.tar.enc	…
setup.cfg	…
shell.nix	[nix] Use niv and poetry2nix to more easily manage dependencies (#11181 )	5 years ago
show_options.mk	add OLED_DRIVER_ENABLE into show_options.mk (#12121 )	5 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 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.