summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2021-05-08Added OLED fade out support (#12086)Barabas
2021-05-07Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-05-07Update FreeBSD install method (#12815)Mateusz Piotrowski
The easiest way to install QMK CLI and all the necessary dependencies on FreeBSD is to use the packages from the official FreeBSD Ports Collection. This is possible since QMK CLI has been added to the Ports Collection: https://www.freshports.org/sysutils/py-qmk/
2021-05-06Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-05-06Add docs on multiple encoders sharing pins (#11678)timothynsheehan
Added explanation of how multiple encoders can share pins and the limitations of this configuration
2021-05-02Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-05-02Shim cli to new keyboard script (#12780)Joel Challis
* Shim cli to new keyboard script * Shim cli to new keyboard script * Add docs
2021-04-29Change RGB/LED Matrix to use a simple define for USB suspend (#12697)Drashna Jaelre
2021-04-26Add STM32L433 and L443 support (#12063)Xelus22
* initial L433 commit * change to XC * fix L433 * disable all peripherals * update system and peripheral clocks * 433 change * use its own board files * revert its own board files * l433 specific change * fix stm32l432xx define * remove duplicate #define * fix bootloader jump * move to L443xx and add i2c2, spi2, usart3 to mcuconf.h * move to L443 * move to L443 * fix sdmmc in mcuconf.h * include STM32L443 * add L443 * Include L443 in compatible microcontrollers Co-authored-by: Nick Brassel <nick@tzarc.org> * Include L443 in compatible microcontrollers Co-authored-by: Nick Brassel <nick@tzarc.org> * Update config bootloader jump description Co-authored-by: Nick Brassel <nick@tzarc.org> * Update ChibiOS define reasoning Co-authored-by: Nick Brassel <nick@tzarc.org> * Update quantum/mcu_selection.mk Co-authored-by: Nick Brassel <nick@tzarc.org> * fix git conflict Co-authored-by: Nick Brassel <nick@tzarc.org>
2021-04-25Add support for MCU = STM32F446 (#12619)Purdea Andrei
* Add support for MCU = STM32F446 * Update platforms/chibios/GENERIC_STM32_F446XE/configs/config.h Co-authored-by: Nick Brassel <nick@tzarc.org> * Restore mcuconf.h to the one used by RT-STM32F446RE-NUCLEO64 * stm32f446: update mcuconf.h and board.h for 16MHz operation, with USB enabled, and other peripherals disabled. Co-authored-by: Nick Brassel <nick@tzarc.org>
2021-04-25Add initial support for tinyuf2 bootloader (when hosted on F411 blackpill) ↵Nick Brassel
(#12600) * Add support for jumping to tinyuf2 bootloader. Adds blackpill UF2 example. * Update flashing.md * Update chconf.h * Update config.h * Update halconf.h * Update mcuconf.h
2021-04-25Update ADC driver for STM32F1xx, STM32F3xx, STM32F4xx (#12403)Sergey Vlasov
* Fix default ADC_RESOLUTION for ADCv3 (and ADCv4) Recent ChibiOS update removed ADC_CFGR1_RES_10BIT from the ADCv3 headers (that macro should not have been there, because ADCv3 has CFGR instead of CFGR1). Fix the default value for ADC_RESOLUTION to use ADC_CFGR_RES_10BITS if it is defined (that name is used for ADCv3 and ADCv4). * Update ADC docs to match the actually used resolution ADC driver for ChibiOS actually uses the 10-bit resolution by default (probably to match AVR); fix the documentation accordingly. Also add both ADC_CFGR_RES_10BITS and ADC_CFGR1_RES_10BIT constants (these names differ according to the ADC implementation in the particular MCU). * Fix pinToMux() for B12 and B13 on STM32F3xx Testing on STM32F303CCT6 revealed that the ADC mux values for B12 and B13 pins were wrong. * Add support for all possible analog pins on STM32F1xx Added ADC mux values for pins A0...A7, B0, B1, C0...C5 on STM32F1xx (they are the same at least for STM32F103x8 and larger F103 devices, and also F102, F105, F107 families). Actually tested on STM32F103C8T6 (therefore pins C0...C5 were not tested). Pins F6...F10, which are present on STM32F103x[C-G] in 144-pin packages, cannot be supported at the moment, because those pins are connected only to ADC3, but the ChibiOS ADC driver for STM32F1xx supports only ADC1. * Add support for all possible analog pins on STM32F4xx Added ADC mux values for pins A0...A7, B0, B1, C0...C5 and optionally F3...F10 (if STM32_ADC_USE_ADC3 is enabled). These mux values are apparently the same for all F4xx devices, except some smaller devices may not have ADC3. Actually tested on STM32F401CCU6, STM32F401CEU6, STM32F411CEU6 (using various WeAct “Blackpill” boards); only pins A0...A7, B0, B1 were tested. Pins F3...F10 are inside `#if STM32_ADC_USE_ADC3` because some devices which don't have ADC3 also don't have the GPIOF port, therefore the code which refers to Fx pins does not compile. * Fix STM32F3xx ADC mux table in documentation The ADC driver documentation had some errors in the mux table for STM32F3xx. Fix this table to match the datasheet and the actual code (mux settings for B12 and B13 were also tested on a real STM32F303CCT6 chip). * Add STM32F1xx ADC pins to the documentation * Add STM32F4xx ADC pins to the documentation
2021-04-25feat: infinite timeout for leader key (#6580)Daniel Rodríguez Rivero
* feat: implement leader_no_timeout logic * docs(leader_key): infinite leader timeout docs
2021-04-20Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-04-20Add additional info to PR Checklist (#12630)Drashna Jaelre
Co-authored-by: Nick Brassel <nick@tzarc.org>
2021-04-19Add Per Key functionality for AutoShift (#11536)Drashna Jaelre
Co-authored-by: Ryan <fauxpark@gmail.com>
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