summaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* Add additional info to PR Checklist (#12630)Drashna Jaelre2021-04-201-0/+9
| | | Co-authored-by: Nick Brassel <nick@tzarc.org>
* eclipse: recommend changing the default project make target (#12447)Michael Stapelberg2021-04-191-13/+15
| | | | | | | | This is required for example for quickly iterating with a debugger, where Eclipse will build the project automatically. It’s also shorter than the previous steps, which I think might not have been updated since https://qmk.fm/changes/2017-09-08-making-from-root-and-no-more-makefiles
* Add support for tab completion (#12411)Zach White2021-04-142-0/+28
| | | | | | | * Add support for tab completion * make flake8 happy * Add documentation
* A few small typo fixes in docs (#12524)Arthur Tabatchnic2021-04-113-5/+5
|
* Documentation update (#12484)swampmonster2021-04-111-2/+2
| | | | | Update documentation to reflect what the actual target flags are Co-authored-by: swampmonster <>
* Update github instruction link in newbs_getting_started.md (#12510)Hawley Waldman2021-04-111-1/+1
| | | Clarify that the link to the github/forking instructions is a link to how to fork this project. Previous wording implied that the link was to a how-to-use github in general page.
* Fix Breaking Change date (#12272)peepeetee2021-04-091-1/+1
|
* 3 new LED effect animations (#9827)TurtleHunter2021-04-031-0/+6
| | | | | Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Erovia <Erovia@users.noreply.github.com>
* [docs] Add IO Warning to WSL section of Getting Started (#12384)Matt Snell2021-03-261-0/+2
| | | | | | | | | * Add IO Warning to WSL section of Getting Started * FauxPark suggestion (thanks!) Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
* Improve upon the 'Caveats' section of the Layers and Mod-Tap documentation ↵Purdea Andrei2021-03-252-6/+6
| | | | | | | | | | | | | | | | | | | | | | | | | (#12306) * Improve upon the 'Caveats' section of the Layers and Mod-Tap documentation * Update docs/mod_tap.md Co-authored-by: Ryan <fauxpark@gmail.com> * Update docs/feature_layers.md Co-authored-by: Ryan <fauxpark@gmail.com> * Update docs/mod_tap.md Co-authored-by: Ryan <fauxpark@gmail.com> * Added a line saying that remote desktop problems may also be mitigated by defining TAP_CODE_DELAY * Update docs/mod_tap.md Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
* Add a `qmk format-json` command that will format JSON files (#12372)Zach White2021-03-251-0/+10
| | | | | | | | | | | * Add a command to format json files * change to work after rebase * add test for qmk format-json * add documentation for qmk format-json * Update lib/python/qmk/cli/format/json.py
* Fix a small typo in cli_commands.md (#12379)Ryan Roden-Corrent2021-03-251-1/+1
|
* More Tap Dance docs improvements (#12358)Ryan2021-03-241-78/+84
|
* Update RGB matrix effects documentation (#12181)peepeetee2021-03-131-3/+5
| | | Co-authored-by: Ryan <fauxpark@gmail.com>
* [Docs] Japanese translation of docs/keycodes.md (#10192)s-show2021-03-051-0/+574
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * copy 'keycodes.md'. * Translated 'keycodes.md'. * Fixed typo. * Fixed typo. * Apply suggestions from code review Co-authored-by: shela <shelaf@users.noreply.github.com> Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * update based on comment. * update based on comment. * Update docs/ja/keycodes.md * update based on comment. Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * update based on comment. Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * update based on comment. Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update docs/ja/keycodes.md Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * update based on comment. Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> Co-authored-by: shela <shelaf@users.noreply.github.com> Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
* Documentation changes SPLIT_USB_DETECT and hid_listen udev rules (#11665)individ-divided2021-03-032-3/+25
| | | Co-authored-by: David Grundberg <david@quartz>
* [Docs] Small spelling mistake fix in leader keys (#12087)L3af2021-03-021-1/+1
|
* [Docs] MATRIX_MASKED docs for SPLIT_HAND_MATRIX_GRID (#11974)Trevor Elliott2021-03-011-0/+4
|
* [Docs] New section to modifier docs: Checking Modifier State (#10550)precondition2021-02-282-1/+136
| | | | | | | | | | | | | | | | | | | | | | | | | | | | * Added new section to docs: Checking Modifier State * Added id anchors to all headers in modifiers docs * Added a Wikipedia link to bitwise operators and... crosslinked to the QMK macro docs. * Added an explanation on the format of mod bitmask * Added .md extension to hyperlinks to macros docs * Corrected mod mask order and changed notation * Documented add_oneshot_mods and del_oneshot_mods * Mentioned modifier checks in the macro docs * Explained strict modifier checking i.e. using `get_mods() & MOD_MASK == MOD_MASK` instead of simply `get_mods() & MOD_MASK` * Added (un)register_mods to the docs * Put left term of comparison in parens
* Add support for using podman to util/docker_build.sh (#10819)Max Audron2021-02-281-1/+9
| | | | | | | | | | | | | * add podman support to docker_build.sh script * break out runtime into the RUNTIME variable * allows RUNTIME to be set by the user * decides on docker or podman if docker isn't avaible * rewrote check for docker-machine to account only for docker runtime * put --user arg into a variable only to be used with docker this is not needed with podman as podman maps the containers root id to the users id. * add podman to getting_started_docker documentation
* Add suggestion for indirect unicode input on Linux (#10854)MRAAGH2021-02-281-0/+21
| | | | | | | | | * Add suggestion for indirect unicode input on Linux I have used this approach myself with great success, and it seems to be the only good solution that doesn't involve IBus. * Elaborate on keyboard layout on Linux This should be enough to allow people to figure out how to add custom characters to a Linux keyboard layout.
* 2021 February 27 Breaking Changes Changelog (#11975)James Young2021-02-274-12/+188
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * restore main readme.md * add ChangeLog entry for 2021-02-27 develop branch - initial version * update Docs; consolidate sidebar entries to new Breaking Changes History doc * Changelog update - concatenate similar changes as one list item - unify change formatting (remove [bracketed] headings and trailing periods) - item sorting improvement * update Changes Requiring User Action section Detail the changes regarding keyboard relocations/additions/deletions. * add entry for fauxpark's user keymap cleanup for config.h/rules.mk * add link to Jacky Studio bugfix PR * add link for "ChibiOS conf migrations... take 15" * add links for "Make LAYOUT parsing more robust" and "Massdrop develop rgb fix" * remove sort sequence numbers * rename Breaking Changes History page Renames the Breaking Changes History page to "Past Breaking Changes". * update schedule in Breaking Changes Overview * suggestions/changes per tzarc * skully's changes * add entry for "Fix develop" (PR 12039) Co-authored-by: Nick Brassel <nick@tzarc.org> Co-authored-by: Zach White <skullydazed@gmail.com>
* Add `tap_code_delay(code, delay)` (#11913)Ryan2021-02-171-2/+8
| | | Co-authored-by: Drashna Jaelre <drashna@live.com>
* RGBLight: Allow configurable default settings (#11912)Ryan2021-02-161-9/+14
| | | | | * RGBLight: Allow configurable default settings * Docs
* Merge remote-tracking branch 'origin/master' into developQMK Bot2021-02-161-2/+2
|\
| * Update IGNORE_MOD_TAP_INTERRUPT (#11452)xgnxs2021-02-151-2/+2
| | | | | | Current wording of IGNORE_MOD_TAP_INTERRUPT is incorrect, and very confusing when attempting to correct a somewhat common issue for quick typists that have Mod-Tap on a commonly used key. Research indicates this wording has been incorrect for some time, and has tripped up others attempting to solve the issue of Mod + Key being sent, when Tap + Key is expected after quickly pressing keys.
* | Split transport mirror (#11046)XScorpion22021-02-163-2/+6
| | | | | | | | | | | | | | * Split transport mirror support * Updated RGB Matrix to respond to electrical events instead of key events * split matrix slave fix
* | Merge branch 'master' into developJoshua Diamond2021-02-142-4/+4
|\|
| * LED Matrix: rename `LED_DRIVER_LED_COUNT` to `DRIVER_LED_TOTAL` (#11858)Ryan2021-02-152-4/+4
| |
* | Merge branch 'master' into developJoshua Diamond2021-02-143-38/+479
|\|
| * [Docs] Japanese translation of adc_driver.md (#10971)umi2021-02-141-0/+155
| | | | | | | | | | | | | | | | | | * add adc_driver.md translation * update based on comment * update based on comment * update based on comment
| * [Docs] Japanese translation of feature_unicode.md (#10985)umi2021-02-141-0/+277
| | | | | | | | | | | | | | | | | | | | | | | | | | * add feature_unicode.md translation * consolidate sentence end * update based on comment * update based on comment * update based on comment * update based on comment
| * LED Matrix: add led_matrix_types.h and implement g_led_config (#11741)Ryan2021-02-141-38/+47
| | | | | | | | | | | | | | | | | | * LED Matrix: add led_matrix_types.h and implement g_led_config * Set correct flags for non-"modifier" LEDs * Clean up docs a little * Add license headers for [led,rgb]_matrix_types.h
* | Audio system overhaul (#11820)Drashna Jaelre2021-02-154-17/+360
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |