Go to file
Evan Travers 08c682c193 Docs: Add docs for the `LAYOUT_*` macro to layouts (#3772)
When moving my planck layout to my let's split, I ran into this issue
because I had copied my planck layout from the default layout which just
used the `{}` array form for the keymap layers. I checked the docs, but
this bit wasn't clear to me. I'm sure @ishtob or @drashna helped me on
discord, but this seemed to be the logical place to add a helpful hint.
2018-08-28 17:35:24 -07:00
.vscode
docs Docs: Add docs for the `LAYOUT_*` macro to layouts (#3772) 2018-08-28 17:35:24 -07:00
drivers ISSI31FL3733 driver (#3679) 2018-08-28 09:03:11 -04:00
keyboards Keyboard: xealous (#3731) 2018-08-28 17:08:07 -07:00
layouts Keymap: Bocaj - Create Userspace and Ergodox Layout (#3750) 2018-08-28 16:48:41 -07:00
lib
quantum ISSI31FL3733 driver (#3679) 2018-08-28 09:03:11 -04:00
tests
tmk_core Tidy up keycode.h (#3666) 2018-08-16 12:12:48 -04:00
users Keymap: xtonhasvim updates (#3768) 2018-08-28 16:54:17 -07:00
util Fix Typos in echo 2018-08-11 13:18:36 -07:00
.clang_complete
.editorconfig
.gitattributes
.gitignore
.gitmodules
.travis.yml
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile
Vagrantfile
autocomplete.sh
book.json
bootloader.mk
build_full_test.mk
build_keyboard.mk
build_layout.mk
build_test.mk
common.mk
common_features.mk ISSI31FL3733 driver (#3679) 2018-08-28 09:03:11 -04:00
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk change messege at 'check-size' target 2018-08-16 12:04:35 -04:00
readme.md Add Atreus as an official board. 2018-08-16 12:01:34 -04:00
secrets.tar.enc
shell.nix
testlist.mk

readme.md

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 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 Erez Zukerman, the Clueboard by Zach White, and the Atreus by Phil Hagelberg.

Official website

http://qmk.fm is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.