aboutsummaryrefslogtreecommitdiffstats
path: root/docs/understanding_qmk.md
AgeCommit message (Collapse)Author
2020-03-23Add Post Processing to process_record (#4892)Gravatar Drashna Jaelre
* Improve process_record system Code based on @colinta's * Rename and better handle functions * Fix incorrect function call to process_record_user * Add documentation for post_process_record * Add both get_event_keycode and get_record_keycode functions And add some comments about these functions * Update code format * Cleanup merge artifacts
2019-10-22Remove apostrophe from various abbreviations' plural forms (#7050)Gravatar Max Rumpf
While this was historically a valid possibility, nowadays, it reads kinda weird, and the [Oxford Dictionaries Online suggests to avoid it](https://english.stackexchange.com/a/56010). Thus, I removed it everywhere I found it.
2019-03-18[Docs] Smallish overhaul of the docs (#5281)Gravatar Drashna Jaelre
* Fix up Common functions doc * Add to extra commands to flashing doc * Rearrange and touch up Macros * Expand Newbs Flashing guide * Update process_record documentation * Add git to best practices name in sidebar * Expand FAQ for build/flashing * Add deprecated info to functions * Update docs/feature_macros.md Co-Authored-By: drashna <drashna@live.com> * Update docs/feature_macros.md Co-Authored-By: drashna <drashna@live.com> * Update docs/flashing.md Co-Authored-By: drashna <drashna@live.com> * Update docs/flashing.md Co-Authored-By: drashna <drashna@live.com> * Update docs/keymap.md Co-Authored-By: drashna <drashna@live.com> * Update docs/newbs_flashing.md Co-Authored-By: drashna <drashna@live.com> * Update docs/newbs_flashing.md Co-Authored-By: drashna <drashna@live.com> * Update docs/custom_quantum_functions.md Co-Authored-By: drashna <drashna@live.com> * Update docs/faq_build.md Co-Authored-By: drashna <drashna@live.com> * Update docs/feature_macros.md Co-Authored-By: drashna <drashna@live.com> * Update docs/keymap.md Co-Authored-By: drashna <drashna@live.com> * Fix up Common functions doc * Make pre-init example accurate * Update docs/custom_quantum_functions.md Co-Authored-By: drashna <drashna@live.com> * Zadig Driver catchall * Spelling Depriciated * Completely remove fn_actions section
2019-02-21Replace instances of KEYMAP with LAYOUTGravatar noroadsleft
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.
2019-01-07Improve consistency in UNICODEMAP code and docs, update ↵Gravatar Konstantin Đorđević
docs/understanding_qmk (#4774) * Remove unused UNICODE(n) macro, update docs * Add note about max length of unicode_map to docs * QK_UNICODE_MAP → QK_UNICODEMAP * Refactor process_unicode_map * process_unicode_map → process_unicodemap This is done for consistency: UNICODEMAP is the method (hence UNICODEMAP_ENABLE, process_unicodemap), whereas unicode_map is the mapping table itself. * Update references and ordering in docs/understanding_qmk * Add additional note to docs/understanding_qmk * &unicode_map[index] → unicode_map + index This avoids the issue of the compiler sometimes complaining about the array index being out of range * Update docs/getting_started_make_guide * Update method sections in docs/feature_unicode
2018-09-17Make `PREVENT_STUCK_MODIFIERS` the default (#3107)Gravatar Joe Wasson
* Remove chording as it is not documented, not used, and needs work. * Make Leader Key an optional feature. * Switch from `PREVENT_STUCK_MODIFIERS` to `STRICT_LAYER_RELEASE` * Remove `#define PREVENT_STUCK_MODIFIERS` from keymaps.
2018-08-29Docs: add process_terminal() and update links to other functions (#3778)Gravatar arlenk
* add process_terminal() and update links to other functions * convert links to permalinks and add a few missing process_* functions * update links in main text as well
2018-03-01Fixed dead links (#2451)Gravatar Brian Choromanski
* Fixed typo of 'confid.h' to 'config.h' * Fixed broken links in docs * Fixed a lot of dead links
2017-12-09Trim trailing whitespaceGravatar fauxpark
2017-11-30Fix internal links in docs/ (#2080)Gravatar Devin J. Pohly
One link in the summary (Modding your keyboard) referred to a page that was deleted; the rest have been updated to point to the new names.
2017-09-18Added Auto Shift, tap key = normal, hold key = shifted state.Gravatar Jeremy Cowgar
2017-08-16Doc updates from going through every fileGravatar skullY
2017-07-03Update a bunch of docsGravatar skullY
2017-06-29Fixup the gitbook configGravatar skullY
2017-06-29Add some gitboot pluginsGravatar skullY
2017-06-28Rough draft for a document on understanding QMKGravatar skullY