Go to file

Dustin Bosveld a9525d88a3 [Keymap] Update readme for ploopy nano keymap (#12733 ) The readme from the Ploopy Mini was accidentally put as the Ploopy Nano readme. The Ploopy Nano does not ship with VIA by default.		2021-06-14 20:06:55 -07:00
.github	…
.vscode	vscode: specify yapf as the formatting provider (#13206 )	2021-06-13 17:52:31 -07:00
api_data	…
bin	Ensure that safe_commands always run (#13199 )	2021-06-14 16:51:58 -07:00
data	…
docs	[Docs] Update Japanese newbs_learn_more_resources.md (#12839 )	2021-06-14 15:31:50 +09:00
drivers	Tidy up spi_master includes (#13053 )	2021-06-03 16:26:41 +10:00
keyboards	[Keymap] Update readme for ploopy nano keymap (#12733 )	2021-06-14 20:06:55 -07:00
layouts	Add default `ortho_1x1` layout (#13118 )	2021-06-07 20:46:22 +10:00
lib	Ensure that safe_commands always run (#13199 )	2021-06-14 16:51:58 -07:00
nix	…
platforms/chibios	Set `BOOTLOADER = stm32-dfu` for all applicable STM32 boards (#12956 )	2021-06-08 19:48:46 +10:00
quantum	Fix Bug with (RGB\|LED)_DISABLE_WHEN_USB_SUSPENDED define (#13060 )	2021-06-09 05:06:55 +10:00
tests	…
tmk_core	…
users	Update noroadsleft userspace and keymaps (2021-06-02) (#13086 )	2021-06-02 23:06:30 -07:00
util	…
.clang-format	…
.editorconfig	…
.gitattributes	…
.gitignore	…
.gitmodules	…
.travis.yml	…
CODE_OF_CONDUCT.md	…
Dockerfile	…
Doxyfile	…
LICENSE	…
Makefile	…
Vagrantfile	…
book.json	…
bootloader.mk	Slightly more prominent LUFA Mass-storage bootloader warning. (#13163 )	2021-06-10 16:05:29 +10:00
build_full_test.mk	…
build_json.mk	…
build_keyboard.mk	…
build_layout.mk	…
build_test.mk	…
common.mk	…
common_features.mk	…
disable_features.mk	…
doxygen-todo	…
license_GPLv2.md	…
license_GPLv3.md	…
license_Modified_BSD.md	…
message.mk	…
nose2.cfg	…
readme.md	…
requirements-dev.txt	Move hid and pyusb to requirements.txt (#13134 )	2021-06-07 16:30:55 -07:00
requirements.txt	Update requirements.txt (#13135 )	2021-06-08 00:37:58 +01:00
secrets.tar.enc	…
setup.cfg	…
shell.nix	…
show_options.mk	…
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.

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.