James Young a03aa301de Remove Full Bootmagic (#13846 ) * disambiguate Bootmagic rules in keymaps The files edited by this commit were added at a point in time where `BOOTMAGIC_ENABLE = yes` enabled full Bootmagic. This commit edits the files to specify that full Bootmagic is intended. * remove BOOTMAGIC_ENABLE=full setting * unify commented BOOTMAGIC_ENABLE rules in keyboards Explicitly sets `BOOTMAGIC_ENABLE = no` in keyboards where the rule was commented out. Command: ``` find keyboards/ -type f -name 'rules.mk' -and -not -path '/keymaps/' -exec sed -i -e 's;#[ \t]\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-zA-Z]\+\).;\1 = no # Virtual DIP switch configuration;g' {} + ``` * remove commented Bootmagic rules from keymap/user level Command: ``` find keyboards/ layouts/ users/ -type f -name 'rules.mk' -exec sed -i -e '/#.\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\)./d' {} + ``` * update keyboard BOOTMAGIC_ENABLE rule formatting Sets the formatting of BOOTMAGIC_ENABLE rules to `BOOTMAGIC_ENABLE = [value]`, without the inline comments (which will be replaced later). Command: ``` find keyboards/ -type f -name 'rules.mk' -and -not -path '/keymaps/' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).;\1 = \2;g' '{}' + ``` update keyboards' BOOTMAGIC_ENABLE settings Updates keyboard `rules.mk` files to use `BOOTMAGIC_ENABLE = lite` where `BOOTMAGIC_ENABLE = full` was being used. Command: ``` find keyboards/ -type f -name 'rules.mk' -and -not -path '/keymaps/' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = \)full;\1lite;g' '{}' + ``` * update keymap/user BOOTMAGIC_ENABLE settings Updates keymap/user `rules.mk` files to use `BOOTMAGIC_ENABLE = lite` where `BOOTMAGIC_ENABLE = full` was being used. Commands: ``` find keyboards/ -type f -name 'rules.mk' -and -path '/keymaps/' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE[ \t=]\+\)full;\1lite;g' '{}' + find layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE[ \t=]\+\)full;\1lite;g' '{}' + ``` * remove and replace inline comments in keyboards and keymap/user files Removes and replaces the inline comments, which have been updated to read `Enable Bootmagic Lite`. Commands: ``` find keyboards/ -type f -name 'rules.mk' -and -path '/keymaps/' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).;\1 = \2;g' '{}' + find layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).;\1 = \2;g' '{}' + find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = lite\);\1 # Enable Bootmagic Lite;g' '{}' + find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = yes\);\1 # Enable Bootmagic Lite;g' '{}' + find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = no\);\1 # Enable Bootmagic Lite;g' '{}' + ``` * rename improperly named makefiles Some files intended to be used as makefiles had improper names causing them to not be used as intended when building. This commit corrects the filenames of the affected files. * update renamed file with new rule formatting * update QMK's template files Updates QMK's `rules.mk` templates to use the new inline comment. * update QMK Docs - remove documentation of full Bootmagic - update links to Bootmagic Lite doc - add doc for Magic Keycodes * rules.mk patch for coarse/ixora and coarse/vinta		2 years ago
.github	CLI/Docs: Fix the format commands' name (#13668)	2 years ago
.vscode	do not automatically format json (#13320)	2 years ago
api_data	Generate api data on each push (#10609)	3 years ago
bin	Ensure that safe_commands always run (#13199)	2 years ago
data	Remove references to info.json `width` and `height` in CLI (#13728)	2 years ago
docs	Remove Full Bootmagic (#13846)	2 years ago
drivers	__flash? (#13799)	2 years ago
keyboards	Remove Full Bootmagic (#13846)	2 years ago
layouts	Remove Full Bootmagic (#13846)	2 years ago
lib	Update ChibiOS-Contrib, mirroring script. (#13896)	2 years ago
nix	Update Python dependencies for Nix (#12855)	2 years ago
platforms/chibios	Remove the #10088 hotfix for Teensy 3.1-like Input:Club keyboards (#12870)	2 years ago
quantum	Remove Full Bootmagic (#13846)	2 years ago
tests	Allow output of logging when running unit tests (#13556)	2 years ago
tmk_core	Add HOLD_ON_OTHER_KEY_PRESS option for dual-role keys (#9404)	2 years ago
users	Remove Full Bootmagic (#13846)	2 years ago
util	Update ChibiOS-Contrib, mirroring script. (#13896)	2 years ago
.clang-format	fix indent size	4 years ago
.editorconfig	QMK CLI and JSON keymap support (#6176)	4 years ago
.gitattributes	[nix] Use niv and poetry2nix to more easily manage dependencies (#11181)	3 years ago
.gitignore	Cleanup gitignore (#13390)	2 years ago
.gitmodules	2020 May 30 Breaking Changes Update (#9215)	3 years ago
.travis.yml	CI: Add workflow for codebase formatting (#7382)	3 years ago
CODE_OF_CONDUCT.md	updates the coc	4 years ago
Dockerfile	Update docker util script and travis to use new base container	4 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	Merge remote-tracking branch 'origin/master' into develop	2 years ago
Vagrantfile	Upgrades Vagrant box to Debian 10 to fix Docker build error on Debian 9. (#13236)	2 years ago
book.json	adds redirects for docs	6 years ago
bootloader.mk	Update LUFA (18-07-2021) and add QMK-HID Bootloader support (#13588)	2 years ago
build_full_test.mk	Ensure single newline at EOF for core files (#11310)	3 years ago
build_json.mk	Fixing incorrect keymap build when switching between multiple keymap.jsons (#12632)	2 years ago
build_keyboard.mk	[Core] Unite half-duplex and full-duplex serial drivers (#13081)	2 years ago
build_layout.mk	Fix building layouts from JSON (#13310)	2 years ago
build_test.mk	Move print/debug files to quantum (#12069)	2 years ago
common.mk	2020 November 28 Breaking Changes Update (#11053)	3 years ago
common_features.mk	Remove Full Bootmagic (#13846)	2 years ago
disable_features.mk	Add a <FEATURE>_SUPPORTED flag (#9058)	3 years ago
doxygen-todo	Remove iWRAP protocol (#9284)	3 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	Update `MSG_PYTHON_MISSING` (#13427)	2 years ago
nose2.cfg	Setup a python test framework	4 years ago
readme.md	Restore standard readme	2 years ago
requirements-dev.txt	Move hid and pyusb to requirements.txt (#13134)	2 years ago
requirements.txt	switch to qmk-dotty-dict (#13460)	2 years ago
secrets.tar.enc	update building for .hex, secrets moving	6 years ago
setup.cfg	Use the schema to eliminate custom code (#11108)	3 years ago
shell.nix	Update Python dependencies for Nix (#12855)	2 years ago
show_options.mk	add yaml_build_options target (#10533)	2 years ago
testlist.mk	Avoid 8-bit timer overflows in debounce algorithms (#12240)	2 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 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.