6169cd52ba
* 🔧 add editorconfig This makes supported editors automatically change their settings to match desired code styles * 🔧 add extension recommendation for VSCode This will cause VS Code to prompt the user to install the EditorConfig extension when they open the project. If this is felt to be too opinionated, I can revert it. |
||
---|---|---|
.vscode | ||
docs | ||
drivers | ||
keyboards | ||
layouts | ||
lib | ||
quantum | ||
tests | ||
tmk_core | ||
users | ||
util | ||
.editorconfig | ||
.gitattributes | ||
.gitignore | ||
.gitmodules | ||
.travis.yml | ||
CODE_OF_CONDUCT.md | ||
Dockerfile | ||
Makefile | ||
Vagrantfile | ||
autocomplete.sh | ||
book.json | ||
build_full_test.mk | ||
build_keyboard.mk | ||
build_layout.mk | ||
build_test.mk | ||
common.mk | ||
common_features.mk | ||
lcd_backlight_keyframes.h | ||
license_GPLv2.md | ||
license_GPLv3.md | ||
license_Modified_BSD.md | ||
message.mk | ||
readme.md | ||
secrets.tar.enc | ||
shell.nix | ||
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.
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.
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, and the Clueboard by Zach White.
Documentation
https://docs.qmk.fm is 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.