Jack Humbert ea7bb624de Update CODE_OF_CONDUCT.md		5 years ago
.vscode	Xton's first keymap! (#2941)	6 years ago
docs	Docs: Format Space Cadet documentation (#3540)	5 years ago
drivers	DC01 keyboard addition (#3428)	5 years ago
keyboards	Keyboard: KBD75 Rev 1 LAYOUT_ansi_1u Bug (#3542)	5 years ago
layouts	Keymap: Adjustments to my Ortho_4x12 layout configs (#3466)	5 years ago
lib	gcc 8.10 compilation fix (#2914)	6 years ago
quantum	Added alternating led underglow pattern (#3498)	5 years ago
tests	add tests for action_layer.c and reset layer state after tests	6 years ago
tmk_core	Loop based vusb_transfer_keyboard	5 years ago
users	Keymaps: correct error in mtdjr userspace for layer_state_set_user (#3521)	5 years ago
util	Added gentoo to installer (#3272)	5 years ago
.clang_complete	Vim Layout for Ergodox-EZ (mac only) (#2112)	6 years ago
.editorconfig	Fix .editorconfig to not mess with line endings	6 years ago
.gitattributes	Set eep files to binary mode	7 years ago
.gitignore	Ajp10304 (#2719)	6 years ago
.gitmodules	Update .gitmodules	6 years ago
.travis.yml	Generate API docs from source code comments (#2491)	6 years ago
CODE_OF_CONDUCT.md	Update CODE_OF_CONDUCT.md	5 years ago
Dockerfile	Reverting CMD Changes	6 years ago
Doxyfile	Generate API docs from source code comments (#2491)	6 years ago
LICENSE	add an explicit lisence file for github to pickup	6 years ago
Makefile	Correct parsing of rules.mk for keyboard revisions	5 years ago
Vagrantfile	removed unused boxes (qmk won't compile with them anyway), updated welcome message	5 years ago
autocomplete.sh	Make arguments redo, subproject elimination (#1784)	6 years ago
book.json	adds redirects for docs	6 years ago
bootloader.mk	Add Teensy ++ 2.0 bootloader support	6 years ago
build_full_test.mk	Add SRC and OPT_DEFS when building tests	6 years ago
build_keyboard.mk	Import userspace config.h according to USER_NAME (#2983)	6 years ago
build_layout.mk	Creates a layouts/ folder for keymaps shared between keyboards (#1609)	6 years ago
build_test.mk	Split common.mk into common.mk and common_features.mk	6 years ago
common.mk	Lets split eh (#3120)	5 years ago
common_features.mk	Lets split eh (#3120)	5 years ago
doxygen-todo	Generate API docs from source code comments (#2491)	6 years ago
license_GPLv2.md	Clarify the quantum license (#1042)	7 years ago
license_GPLv3.md	Clarify the quantum license (#1042)	7 years ago
license_Modified_BSD.md	Clarify the quantum license (#1042)	7 years ago
message.mk	Reset color after submodule warning message	6 years ago
readme.md	add discord link	6 years ago
secrets.tar.enc	update building for .hex, secrets moving	6 years ago
shell.nix	allow building with nix on darwin	5 years ago
testlist.mk	Add basic infrastrucure for building full tests	6 years ago

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 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, and the Clueboard by Zach White.

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.