summaryrefslogtreecommitdiffstats
path: root/docs/faq_keymap.md
Commit message (Collapse)AuthorAgeFilesLines
* Remove Full Bootmagic (#13846)James Young2021-08-061-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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
* [Docs] Use HTTPS for images and links where possible (#11695)Ryan2021-01-301-5/+5
|
* make custom_keycode_names.md a faq entry insteadskullY2020-03-051-0/+11
|
* [Docs] Remove some outdated FAQ items (#7607)fauxpark2019-12-111-62/+1
|
* Remove obsolete note about media keys in MacOS (#6631)Steve Purcell2019-10-301-7/+0
| | | | | | | | | | | | | | * Remove obsolete note about media keys in MacOS KC_MNXT and KC_MPRV work fine on MacOS, so this note is obsolete. * Document behaviour of MEDIA_FAST_FORWARD/MEDIA_REWIND codes on MacOS * Small typo fix, and make OS-dependent keycode claim less absolute * Update docs/keycodes_basic.md Co-Authored-By: fauxpark <fauxpark@gmail.com>
* Replace instances of KEYMAP with LAYOUTnoroadsleft2019-02-211-2/+2
| | | | | | Many instances in the QMK Docs referenced KEYMAP macros, which is outdated terminology. Replaced most instances of KEYMAP with LAYOUT, to reflect the desired usage.
* Add tap_random_base64 and software timer info to Useful Functions doc (#4360)Drashna Jaelre2018-12-011-17/+0
| | | | | | | | | | | | | | | | * Update docs * Add security caveat Co-Authored-By: drashna <drashna@live.com> * Wordsmithing Co-Authored-By: drashna <drashna@live.com> * Update docs/ref_functions.md Co-Authored-By: drashna <drashna@live.com>
* Keymap FAQ: fix positions of KC_HENK and KC_MHEN for JIS layout (#4482)noroadsleft2018-11-251-2/+2
| | | These keys were previously in each other's positions.
* Docs: Update image in FAQ/Keymap: KC_EQLS -> KC_EQL (#3660)zgtm2018-08-151-2/+2
|
* Update FAQ section on power keysfauxpark2018-08-111-5/+4
|
* Update FAQ section on Apple Fn (#3574)fauxpark2018-08-051-5/+5
|
* More thoroughly document Bootmagic and Command (#2455)skullydazed2018-03-021-12/+21
|
* backlight breathing overhaul (#2187)Balz Guenat2018-01-011-1/+1
| | | | | | | | | | | | | | | | | | | | * add breathing to bananasplit * backlight breathing overhaul * fix the backlight_tick thing. * fix for vision_division backlight * fix a few keymaps and probably break breathing for some weirdly set-up boards. * remove BL_x keycodes because they made unreasonable assumptions * some fixes for BL keycodes * integer cie lightness scaling * use cie lightness for non-breathing backlight and make breathing able to reach true max brightness
* Trim trailing whitespacefauxpark2017-12-091-2/+2
|
* Fix some of the more obvious typosfauxpark2017-12-091-5/+5
|
* Convert all headings to Title Casefauxpark2017-12-091-16/+16
|
* Flesh out the grave escape overridesskullY2017-12-031-4/+2
|
* Restructure the hardware and feature docs to make things easier to find (#1888)skullydazed2017-10-241-0/+11
| | | | | | * fix #1313 by documenting more config.h options * Clean up and organize documentation
* Doc updates from going through every fileskullY2017-08-161-2/+2
|
* Overhaul the Getting Started section and add a FAQ sectionskullY2017-08-161-1/+1
|
* fix code block formattingBalz Guenat2017-08-111-1/+1
|
* add description of new option to docs and add option (commented out) into ↵Balz Guenat2017-08-111-1/+3
| | | | template.
* Update a bunch of docsskullY2017-07-031-74/+20
|
* convert docs to lowercase and underscoresJack Humbert2017-06-101-0/+265
generated by cgit v1.2.3 (git 2.25.1) at 2024-12-04 10:38:42 +0000