Custom keyboard firmware

Go to file

Astrid Yu c0ab4ed539 Allow overriding Niv inputs in shell.nix (#16602 )		11 months ago
.github	Run auto approve only on qmk/qmk_firmware (#16786 )	12 months ago
.vscode	remove Bracket Pair Colorizer recommendation (#14816 )	1 year ago
api_data	Generate api data on each push (#10609 )	2 years ago
builddefs	Ensure .hex file output for ARM Teensys (#17014 )	11 months ago
data	Lint keyboard/project name (#16766 )	1 year ago
docs	Add Ukrainian keymap header (#16947 )	11 months ago
drivers	Fix external flash on AVR (#16851 )	12 months ago
keyboards	[Keyboard] Move M63 RGB into maker folder (#17061 )	11 months ago
layouts	[Keymap] ergodox: updating osx_whiskey_tango_foxtrot_capslock to use process_record_user (#16715 )	1 year ago
lib	yapf: disable arithmetic predecence indication (#16749 )	1 year ago
platforms	[Bug] Fix unused variable error when using ChibiOS Bitbang serial driver (#16709 )	1 year ago
quantum	Add Ukrainian keymap header (#16947 )	11 months ago
tests	Format code according to conventions (#16322 )	1 year ago
tmk_core	VUSB - Use correct endpoint poll for VIA (#16691 )	1 year ago
users	[Keymap] Toinux's crkbd keymap and userspace (#16437 )	11 months ago
util	Add missing dependency for qmk setup on Fedora (#17003 )	11 months ago
.clang-format	Clang-format tweaks (#15906 )	1 year ago
.editorconfig	QMK CLI and JSON keymap support (#6176 )	4 years ago
.gitattributes	eol=lf, where appropriate (#15752 )	1 year ago
.gitignore	Ignore VIA(L) json files (#16845 )	12 months ago
.gitmodules	Purge uGFX. (#14720 )	1 year ago
Dockerfile	move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230 )	2 years ago
Doxyfile	Internal docs generation updates (#16411 )	1 year ago
LICENSE	add an explicit lisence file for github to pickup	5 years ago
Makefile	Migrate more makefile utilities to builddefs sub-directory (#16002 )	1 year ago
Vagrantfile	move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230 )	2 years ago
doxygen-todo	Remove SERIAL_LINK feature (#14727 )	1 year ago
license_GPLv2.md	Clarify the quantum license (#1042 )	6 years ago
license_GPLv3.md	Clarify the quantum license (#1042 )	6 years ago
license_Modified_BSD.md	Clarify the quantum license (#1042 )	6 years ago
nose2.cfg	Setup a python test framework	4 years ago
paths.mk	Migrate more makefile utilities to builddefs sub-directory (#16002 )	1 year ago
readme.md	[Core] [Docs] Remove travis-ci references (#13916 )	2 years ago
requirements-dev.txt	Macros in JSON keymaps (#14374 )	1 year ago
requirements.txt	switch to qmk-dotty-dict (#13460 )	2 years ago
setup.cfg	yapf: disable arithmetic predecence indication (#16749 )	1 year ago
shell.nix	Allow overriding Niv inputs in shell.nix (#16602 )	11 months 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 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.