summaryrefslogtreecommitdiffstats
path: root/docs/hardware_keyboard_guidelines.md
Commit message (Collapse)AuthorAgeFilesLines
* [Docs] Clean up some code block languages (#14434)Ryan2021-09-141-2/+2
|
* add 'include keyboard_features.mk' into build_keyboard.mk (#8422)Takeshi ISHII2021-08-291-0/+28
| | | | | | | | | | | * add 'include keyboard_features.mk' into build_keyboard.mk keyboard_features.mk is a keyboard-local version of the functions performed by common_features.mk. * add comment into build_keyboard.mk * added description of keyboard_features.mk in hardware_keyboard_guidelines.md. * rename `keyboard_features.mk` to `post_rules.mk`
* Remove Full Bootmagic (#13846)James Young2021-08-061-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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-2/+2
|
* New command: qmk lint (#10761)Zach White2020-11-071-0/+19
| | | | | | | | | | | | | | | | | | | | | | | | | * Basic qmk lint command * check for keymap readme * change the workflow from qmk info to qmk lint * add a strict mode * parsing -> parse * document qmk lint * small info logging cleanup * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> * honor --strict in more places * change the job name to lint Co-authored-by: Ryan <fauxpark@gmail.com>
* Fixes small typo in docs (#10515)Joe Strong2020-10-051-1/+1
|
* [Docs] added the description of the reading order of the rules.mk files. (#8566)Takeshi ISHII2020-03-291-0/+15
| | | | | | | | | | | | | * added the description of the reading order of the rules.mk files. * Update docs/hardware_keyboard_guidelines.md Co-Authored-By: Ryan <fauxpark@gmail.com> * Update docs/hardware_keyboard_guidelines.md Co-Authored-By: Ryan <fauxpark@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
* [Docs] added the description of the reading order of the config.h files. (#8545)Takeshi ISHII2020-03-251-0/+51
| | | | | | | | | | | | | | | | | | | | | | * added the description of the reading order of the config.h files. * Update docs/hardware_keyboard_guidelines.md * Update docs/hardware_keyboard_guidelines.md * Added a description of post_config.h. * sample bug fix * sample update * Update docs/hardware_keyboard_guidelines.md * Update docs/hardware_keyboard_guidelines.md * update docs/hardware_keyboard_guidelines.md * Update docs/hardware_keyboard_guidelines.md
* Fixed typos in documentation (#6871)Erik Doffagne2019-10-021-1/+1
| | | | | | | | | | | | * Fixed typos in documentation * Update docs/arm_debugging.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/arm_debugging.md Co-Authored-By: fauxpark <fauxpark@gmail.com>
* Clarify LAYOUT vs LAYOUT_allskullY2019-02-081-3/+5
|
* Address comments in #4832. Move info.json reference to its own file.skullY2019-02-081-81/+16
|
* Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević2019-02-081-1/+1
| | | Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević2019-02-081-1/+1
| | | Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević2019-02-081-1/+1
| | | Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević2019-02-081-1/+1
| | | Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević2019-02-081-1/+1
| | | Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević2019-02-081-1/+1
| | | Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević2019-02-081-1/+1
| | | Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević2019-02-081-1/+1
| | | Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević2019-02-081-1/+1
| | | Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević2019-02-081-1/+1
| | | Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević2019-02-081-1/+1
| | | Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* Update docs/hardware_keyboard_guidelines.mdfauxpark2019-02-081-1/+1
| | | Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* tweak the keyboard guidelinesskullY2019-02-081-4/+6
|
* Update the keyboard guidelinesskullY2019-02-081-3/+77
|
* Remove bootloader key as it is no longer used (#3093)Dan Hertz2018-06-011-10/+0
|
* Remove obsolete info.json entries (#2712)skullydazed2018-04-071-9/+0
|
* Fix broken Markdown (#2652)Mike Kozlowski2018-03-311-2/+2
| | | Fix links in Keyboard Guidelines page
* Added bootloader optionsMerlin042018-03-201-1/+3
| | | I think I got all of them, so I removed the "FIXME".
* Mention invalid names in the readme. (#2458)Graham P Heath2018-03-031-1/+1
|
* More thoroughly document Bootmagic and Command (#2455)skullydazed2018-03-021-0/+16
|
* Trim trailing whitespacefauxpark2017-12-091-1/+1
|
* Convert all headings to Title Casefauxpark2017-12-091-6/+6
|
* use real greater than and less than charsskullY2017-11-021-1/+1
|
* Document info.json filesskullY2017-11-021-0/+88
|
* Restructure the hardware and feature docs to make things easier to find (#1888)skullydazed2017-10-241-0/+49
* fix #1313 by documenting more config.h options * Clean up and organize documentation
generated by cgit v1.2.3 (git 2.25.1) at 2024-12-14 16:03:14 +0000