summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2021-04-19Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-04-19eclipse: recommend changing the default project make target (#12447)Michael Stapelberg
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
2021-04-18Enhancement of WPM feature (#11727)Drashna Jaelre
2021-04-15Add missing RGB_MODE_TWINKLE / RGB_M_TW keycodes (#11935)Joshua Diamond
* Add missing RGB_MODE_TWINKLE / RGB_M_TW keycodes * Better comment Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
2021-04-15Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-04-14Add support for tab completion (#12411)Zach White
* Add support for tab completion * make flake8 happy * Add documentation
2021-04-13Terrazzo: Fix wrong LED Matrix function names (#12561)Ryan
2021-04-12Change `BOOTMAGIC_ENABLE=yes` to use Bootmagic Lite (#12172)James Young
2021-04-11Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-04-11A few small typo fixes in docs (#12524)Arthur Tabatchnic
2021-04-11Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-04-11Documentation update (#12484)swampmonster
Update documentation to reflect what the actual target flags are Co-authored-by: swampmonster <>
2021-04-11Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-04-11Update github instruction link in newbs_getting_started.md (#12510)Hawley Waldman
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.
2021-04-09Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-04-09Fix Breaking Change date (#12272)peepeetee
2021-04-03Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-04-033 new LED effect animations (#9827)TurtleHunter
Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Erovia <Erovia@users.noreply.github.com>
2021-03-26Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-03-26[docs] Add IO Warning to WSL section of Getting Started (#12384)Matt Snell
* 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>
2021-03-25Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-03-25Improve upon the 'Caveats' section of the Layers and Mod-Tap documentation ↵Purdea Andrei
(#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>
2021-03-25Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-03-25Add a `qmk format-json` command that will format JSON files (#12372)Zach White
* 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
2021-03-25Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-03-25Fix a small typo in cli_commands.md (#12379)Ryan Roden-Corrent
2021-03-24Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-03-24More Tap Dance docs improvements (#12358)Ryan
2021-03-19ARM WS2812 SPI config (baudrate and circular buffer) (#12216)Xelus22
* initial commit * include circular buffer command * add endif * circular buffer mode * remove untrue comment * revamp and add documentation * do not allow WS2812_SPI_SYNC & CIRCULAR_BUFFER
2021-03-13Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-03-13Update RGB matrix effects documentation (#12181)peepeetee
Co-authored-by: Ryan <fauxpark@gmail.com>
2021-03-04Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-03-05[Docs] Japanese translation of docs/keycodes.md (#10192)s-show
* 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>
2021-03-03Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-03-03Documentation changes SPLIT_USB_DETECT and hid_listen udev rules (#11665)individ-divided
Co-authored-by: David Grundberg <david@quartz>
2021-03-02Add support for complementary outputs to the WS2812 PWM driver (#11988)Sergey Vlasov
2021-03-03Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-03-02[Docs] Small spelling mistake fix in leader keys (#12087)L3af
2021-03-03Split RGB Matrix (#11055)XScorpion2
* Split RGB Matrix * Suspend State sync for rgb matrix
2021-03-02Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-03-01[Docs] MATRIX_MASKED docs for SPLIT_HAND_MATRIX_GRID (#11974)Trevor Elliott
2021-03-01Add ability to toggle One Shot functionality (#4198)Drashna Jaelre
Co-authored-by: Nick Brassel <nick@tzarc.org> Co-authored-by: Ryan <fauxpark@gmail.com>
2021-02-28[Docs] New section to modifier docs: Checking Modifier State (#10550)precondition
* 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
2021-02-28Add support for using podman to util/docker_build.sh (#10819)Max Audron
* 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
2021-02-28Add suggestion for indirect unicode input on Linux (#10854)MRAAGH
* 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-02-272021 February 27 Breaking Changes Changelog (#11975)James Young
* 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>
2021-02-17Add `tap_code_delay(code, delay)` (#11913)Ryan
Co-authored-by: Drashna Jaelre <drashna@live.com>
2021-02-16RGBLight: Allow configurable default settings (#11912)Ryan
* RGBLight: Allow configurable default settings * Docs
2021-02-16Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-02-15Update IGNORE_MOD_TAP_INTERRUPT (#11452)xgnxs
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.