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

arlenk 380e05ad6e Update getting_started_make_guide.md (#7538 ) * Update getting_started_make_guide.md clarifying that NO_PRINT and USER_PRINT should not be used at the same time. * Update docs/getting_started_make_guide.md Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com>		6 years ago
.github	Fix typos in stale.yml (#7489 )	6 years ago
.vscode	…
bin	Add pep8-naming to our python linting	6 years ago
docs	Update getting_started_make_guide.md (#7538 )	6 years ago
drivers	Increase matrix scanning speed on xd84 (#7517 )	6 years ago
keyboards	[Keymap] Dactyl Manuform computer scientist's layout with split RGB enabled (#7519 )	6 years ago
layouts	Jotix (#7549 )	6 years ago
lib	Add pep8-naming to our python linting	6 years ago
quantum	Fix breathing toggle when rgb is disabled (#7550 )	6 years ago
tests	…
tmk_core	Remove vusb 'reset to bootloader' hid message due to security implications (#7456 )	6 years ago
users	[Keymap] Add RGB keycodes to keymap, enable RGB_MATRIX on crkbd (#7499 )	6 years ago
util	Fix install for Linux Ubuntu (#7520 )	6 years ago
.clang-format	…
.clang_complete	…
.editorconfig	…
.gitattributes	…
.gitignore	…
.gitmodules	…
.travis.yml	…
CODE_OF_CONDUCT.md	…
Dockerfile	…
Doxyfile	…
LICENSE	…
Makefile	Allow 'make all:<user>' to not build EVERYTHING (#7402 )	6 years ago
Vagrantfile	…
autocomplete.sh	…
book.json	…
bootloader.mk	…
build_full_test.mk	…
build_json.mk	Make generating keymap.c from JSON more reliable	6 years ago
build_keyboard.mk	…
build_layout.mk	…
build_test.mk	…
common.mk	…
common_features.mk	Relocate magic keycode processing (#7512 )	6 years ago
doxygen-todo	…
license_GPLv2.md	…
license_GPLv3.md	…
license_Modified_BSD.md	…
message.mk	…
nose2.cfg	…
readme.md	Set up language fallback for docs, and update translation guidelines (#7403 )	6 years ago
requirements.txt	Add pep8-naming to our python linting	6 years ago
secrets.tar.enc	…
setup.cfg	Add flake8 to our test suite and fix all errors (#7379 )	6 years ago
shell.nix	Fix shell.nix by pinning nixpkgs (#6213 )	6 years ago
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 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.