Go to file
Bram de Wilde 2c201ab9ad Update newbs_getting_started.md
qmk is not available in the official Arch repositories. It is in the AUR, this install command will work if user has `yay` installed.
2020-03-31 14:26:19 -07:00
.github
.vscode
bin CLI: More MSYS2 fixes (#8577) 2020-03-29 14:29:44 +02:00
docs Update newbs_getting_started.md 2020-03-31 14:26:19 -07:00
drivers fixed problem with implicit declaration in quantum/rgblight.c (#8406) 2020-03-28 23:35:11 +00:00
keyboards [Keymap] Sigul planck (#8546) 2020-03-31 14:15:16 -07:00
layouts [Keymap] Add spidey3 keymap for 75_ansi, and a spidey3 userspace (#8470) 2020-03-22 21:11:41 -07:00
lib CLI: More MSYS2 fixes (#8577) 2020-03-29 14:29:44 +02:00
quantum Rename UC_OSX (and related constants) to UC_MAC (#8589) 2020-03-31 18:28:43 +02:00
tests
tmk_core V-USB: Consolidate usbconfig.h's into a single file (#8584) 2020-03-31 13:17:04 +01:00
users [Keymap] Sigul planck (#8546) 2020-03-31 14:15:16 -07:00
util
.clang_complete
.clang-format
.editorconfig
.gitattributes
.gitignore
.gitmodules
.travis.yml
autocomplete.sh
book.json
bootloader.mk
build_full_test.mk
build_json.mk
build_keyboard.mk Align some ChibiOS build logic (#8461) 2020-03-22 20:48:17 +11:00
build_layout.mk
build_test.mk Initial arm->chibios pass - simplify some platform logic (#8450) 2020-03-21 16:20:04 +11:00
CODE_OF_CONDUCT.md
common_features.mk Add Word Per Minute calculation feature (#8054) 2020-03-23 00:06:16 +11:00
common.mk
Dockerfile
Doxyfile
doxygen-todo
LICENSE
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
Makefile
message.mk
nose2.cfg
readme.md
requirements.txt
secrets.tar.enc
setup.cfg
shell.nix
show_options.mk
testlist.mk
Vagrantfile

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