summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2021-07-01[Docs] update Japanese translation of other_eclipse.md (#12776)umi
* update other_eclipse.md translation * update based on comment * update based on comment
2021-07-01update Japanese translation of config_options.md (#12695)umi
* update config_options.md translation * update config_options.md translation * update based on comment * update based on comment
2021-07-01Translated 'feature_advanced_keycodes.md'. (#12454)s-show
* Translated 'feature_advanced_keycodes.md'. * Update docs/ja/feature_advanced_keycodes.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/feature_advanced_keycodes.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/feature_advanced_keycodes.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/feature_advanced_keycodes.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/feature_advanced_keycodes.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/feature_advanced_keycodes.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/feature_advanced_keycodes.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/feature_advanced_keycodes.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/feature_advanced_keycodes.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/feature_advanced_keycodes.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/feature_advanced_keycodes.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/feature_advanced_keycodes.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/feature_advanced_keycodes.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/feature_advanced_keycodes.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/feature_advanced_keycodes.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/feature_advanced_keycodes.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/feature_advanced_keycodes.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/feature_advanced_keycodes.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/feature_advanced_keycodes.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/feature_advanced_keycodes.md Co-authored-by: shela <shelaf@users.noreply.github.com> * update based on comment. * 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> Co-authored-by: shela <shelaf@users.noreply.github.com> Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
2021-07-01[Docs] Japanese translation of docs/keycodes_basic.md (#11044)s-show
* 'keycodes_basic.md' copied. * Translation completed. * update to "breakpoint_2021_05_29". * Update docs/ja/keycodes_basic.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/keycodes_basic.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/keycodes_basic.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/keycodes_basic.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/keycodes_basic.md Co-authored-by: shela <shelaf@users.noreply.github.com> * update based on comment. * update based on comment. Co-authored-by: shela <shelaf@users.noreply.github.com>
2021-07-01[Update] Change Original TAGs of Japanese translations (#13396)Takeshi ISHII
* Updated docs/ja/how_a_matrix_works.md original tag. * Updated docs/ja/api_overview.md original tag. * Updated docs/ja/contributing.md original tag * Updated docs/ja/coding_conventions_c.md original tag * Updated docs/ja/reference_configurator_support.md original tag * Updated docs/ja/reference_glossary.md original tag * Updated docs/ja/api_docs.md original tag * Updated docs/ja/feature_stenography.md original tag * Updated docs/ja/documentation_templates.md original tag * Updated docs/ja/faq_keymap.md original tag * Updated docs/ja/understanding_qmk.md original tag
2021-06-24Update Japanese document (#10673)shela
2021-06-24[Docs] Update Japanese faq documents (#12842)shela
* Update Japanese faq documents. * Update Japanese summary. * Update docs/ja/faq_debug.md Co-authored-by: s-show <s1shimz@gmail.com> * Update docs/ja/faq_misc.md Co-authored-by: s-show <s1shimz@gmail.com> * Apply suggestions from code review Co-authored-by: s-show <s1shimz@gmail.com>
2021-06-24Update Japanese newbs_getting_started.md (#12841)shela
2021-06-24Add ID to "## Advanced Macros". (#12830)s-show
2021-06-22[Docs] pr_checklist: fix capitalization of Vial (#13301)xyzz
2021-06-22Additional documentation for GUI mod combo (#13266)Albert Y
Co-authored-by: filterpaper <filterpaper@localhost>
2021-06-21Cleanup junk characters, part 1 (#13282)Ryan
2021-06-21[Docs] Update Japanese getting started documents. (#12806)shela
* Update Japanese getting started documents. * Update faq_build.md * fix typo
2021-06-19Add Mac centric Shift and Alt + GUI Macros (#13107)Albert Y
Co-authored-by: filterpaper <filterpaper@localhost>
2021-06-18[Docs] update Japanese translation of tap_hold.md (#12820)umi
* update tap_hold.md translation * restore unnecessary change line
2021-06-18[Docs] update Japanese translation of hardware_keyboard_guidelines.md (#12769)umi
* update hardware_keyboard_guidelines.md translation * update based on comment
2021-06-18[Docs] update Japanese translation of feature_haptic_feedback.md (#12737)umi
* update feature_haptic_feedback.md translation * change url of driver pdf location * change buzz word * update based on comment
2021-06-18Update merge sequence to reflect no-ff, no-squash. (#13038)Nick Brassel
2021-06-17OLED driver tweaks (#13215)Ryan
2021-06-15Document user song list file (#13101)Drashna Jaelre
2021-06-15Top level heading for common config (LED Matrix) (#13153)Brian Low
2021-06-15Top level heading for common config (RGB Matrix) (#13120)Brian Low
* Top level heading for common config Prior to this, the some of the common config looks like a detail of the APA102 driver * Change heading to Common Config (RGB Matrix)
2021-06-15[Docs] Update one_shot_keys.md (#12291)Thomas Museus Dabay
2021-06-14[Docs] Update Japanese newbs_learn_more_resources.md (#12839)shela
* Update Japanese newbs_learn_more_resources.md document. * Slightly modded
2021-06-13[Docs] Update feature_split_keyboard.md (#13205)Markus Knutsson
2021-06-13[Docs] update Japanese translation of feature_pointing_device.md (#12753)umi
* update feature_pointing_device.md translation * update based on comment
2021-06-13[Docs] Update Japanese newbs_flashing.md (#12837)shela
* Update Japanese newbs_flashing.md document. * Slightly modded * Apply suggestions from code review
2021-06-13Update Japanese newbs.md document. (#12835)shela
2021-06-13[Docs] Japanese translation of docs/data_driven_config.md (#12066)Takeshi ISHII
* add docs/ja/data_driven_config.md * Update docs/ja/data_driven_config.md Co-authored-by: s-show <s1shimz@gmail.com> * Update docs/ja/data_driven_config.md Co-authored-by: s-show <s1shimz@gmail.com> * Update docs/ja/data_driven_config.md Co-authored-by: s-show <s1shimz@gmail.com> * Update docs/ja/data_driven_config.md Co-authored-by: s-show <s1shimz@gmail.com> * Update docs/ja/data_driven_config.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/data_driven_config.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/data_driven_config.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/data_driven_config.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/data_driven_config.md * Update docs/ja/data_driven_config.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/data_driven_config.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/data_driven_config.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/data_driven_config.md Co-authored-by: shela <shelaf@users.noreply.github.com> Co-authored-by: s-show <s1shimz@gmail.com> Co-authored-by: shela <shelaf@users.noreply.github.com>
2021-06-08Update Japanese newbs_building_firmware_configurator.md document. (#12836)shela
2021-06-08update ref_functions.md translation (#12784)umi
2021-06-08update one_shot_keys.md translation (#12771)umi
2021-06-08update hardware_avr.md translation (#12760)umi
2021-06-08update feature_rawhid.md translation (#12759)umi
2021-06-08[Docs] update Japanese translation of custom_quantum_functions.md (#12715)umi
* update custom_quantum_functions.md translation * update custom_quantum_functions.md translation * explicitly describe pronoun * update based on comment * update based on comment
2021-06-06[Docs] added basic midi documention of common features (#13113)wxyangf
Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Joel Challis <git@zvecr.com>
2021-06-06Update Japanese document (#10670)shela
Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
2021-06-06update feature_layers.md translation (#12752)umi
2021-06-03Fix up WS2812 SPI driver on F072. (#13022)Nick Brassel
2021-05-292021 May 29 Breaking Changes Update (#13034)James Young
* Add Per Key functionality for AutoShift (#11536) * LED Matrix: Reactive effect buffers & advanced indicators (#12588) * [Keyboard] kint36: switch to sym_eager_pk debouncing (#12626) * [Keyboard] kint2pp: reduce input latency by ≈10ms (#12625) * LED Matrix: Split (#12633) * [CI] Format code according to conventions (#12650) * feat: infinite timeout for leader key (#6580) * feat: implement leader_no_timeout logic * docs(leader_key): infinite leader timeout docs * Format code according to conventions (#12680) * Update ADC driver for STM32F1xx, STM32F3xx, STM32F4xx (#12403) * 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 * Add initial support for tinyuf2 bootloader (when hosted on F411 blackpill) (#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 * eeprom driver: Refactor where eeprom driver initialisation (and EEPROM emulation initialisation) occurs to make it non-target-specific. (#12671) * Add support for MCU = STM32F446 (#12619) * Add support for MCU = STM32F446 * Update platforms/chibios/GENERIC_STM32_F446XE/configs/config.h * 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. * Format code according to conventions (#12682) * Format code according to conventions (#12687) * Add STM32L433 and L443 support (#12063) * 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 * Include L443 in compatible microcontrollers * Update config bootloader jump description * Update ChibiOS define reasoning * Update quantum/mcu_selection.mk * fix git conflict * Updated Function96 with V2 files and removed chconf.h and halconf.h (#12613) * Fix bad PR merge for #6580. (#12721) * Change RGB/LED Matrix to use a simple define for USB suspend (#12697) * [CI] Format code according to conventions (#12731) * Fixing transport's led/rgb matrix suspend state logic (#12770) * [CI] Format code according to conventions (#12772) * Fix comment parsing (#12750) * Added OLED fade out support (#12086) * fix some references to bin/qmk that slipped in (#12832) * Resolve a number of warnings in `qmk generate-api` (#12833) * New command: qmk console (#12828) * stash poc * stash * tidy up implementation * Tidy up slightly for review * Tidy up slightly for review * Bodge environment to make tests pass * Refactor away from asyncio due to windows issues * Filter devices * align vid/pid printing * Add hidapi to the installers * start preparing for multiple hid_listeners * udev rules for hid_listen * refactor to move closer to end state * very basic implementation of the threaded model * refactor how vid/pid/index are supplied and parsed * windows improvements * read the report directly when usage page isn't available * add per-device colors, the choice to show names or numbers, and refactor * add timestamps * Add support for showing bootloaders * tweak the color for bootloaders * Align bootloader disconnect with connect color * add support for showing all bootloaders * fix the pyusb check * tweaks * fix exception * hide a stack trace behind -v * add --no-bootloaders option * add documentation for qmk console * Apply suggestions from code review * pyformat * clean up and flesh out KNOWN_BOOTLOADERS * Remove pointless SERIAL_LINK_ENABLE rules (#12846) * Make Swap Hands use PROGMEM (#12284) This converts the array that the Swap Hands feature uses to use PROGMEM, and to read from that array, as such. Since this array never changes at runtime, there is no reason to keep it in memory. Especially for AVR boards, as memory is a precious resource. * Fix another bin/qmk reference (#12856) * [Keymap] Turn OLED off on suspend in soundmonster keymap (#10419) * Fixup build errors on `develop` branch. (#12723) * LED Matrix: Effects! (#12651) * Fix syntax error when compiling for ARM (#12866) * Remove KEYMAP and LAYOUT_kc (#12160) * alias KEYMAP to LAYOUT * remove KEYMAP and LAYOUT_kc * Add setup, clone, and env to the list of commands we allow even with broken modules (#12868) * Rename `point_t` -> `led_point_t` (#12864) * [Keyboard] updated a vendor name / fixed minor keymap issues (#12881) * Add missing LED Matrix suspend code to suspend.c (#12878) * LED Matrix: Documentation (#12685) * Deprecate `send_unicode_hex_string()` (#12602) * Fix spelling mistake regarding LED Matrix in split_common. (#12888) * [Keymap] Fix QWERTY/DVORAK status output for kzar keymap (#12895) * Use milc.subcommand.config instead of qmk.cli.config (#12915) * Use milc.subcommand.config instead * pyformat * remove the config test * Add function to allow repeated blinking of one layer (#12237) * Implement function rgblight_blink_layer_repeat to allow repeated blinking of one layer at a time * Update doc * Rework rgblight blinking according to requested change * optimize storage * Fixup housekeeping from being invoked twice per loop. (#12933) * matrix: wait for row signal to go HIGH for every row (#12945) I noticed this discrepancy (last row of the matrix treated differently than the others) when optimizing the input latency of my keyboard controller, see also https://michael.stapelberg.ch/posts/2021-05-08-keyboard-input-latency-qmk-kinesis/ Before this commit, when tuning the delays I noticed ghost key presses when pressing the F2 key, which is on the last row of the keyboard matrix: the dead_grave key, which is on the first row of the keyboard matrix, would be incorrectly detected as pressed. After this commit, all keyboard matrix rows are interpreted correctly. I suspect that my setup is more susceptible to this nuance than others because I use GPIO_INPUT_PIN_DELAY=0 and hence don’t have another delay that might mask the problem. * ensure we do not conflict with existing keymap aliases (#12976) * Add support for up to 4 IS31FL3733 drivers (#12342) * Convert Encoder callbacks to be boolean functions (#12805) * [Keyboard] Fix Terrazzo build failure (#12977) * Do not hard set config in CPTC files (#11864) * [Keyboard] Corne - Remove legacy revision support (#12226) * [Keymap] Update to Drashna keymap and user code (based on develop) (#12936) * Add Full-duplex serial driver for ARM boards (#9842) * Document LED_MATRIX_FRAMEBUFFER_EFFECTS (#12987) * Backlight: add defines for default level and breathing state (#12560) * Add dire message about LUFA mass storage bootloader (#13014) * [Keyboard] Remove redundant legacy and common headers for crkbd (#13023) Was causing compiler errors on some systems. * Fix keyboards/keymaps for boolean encoder callback changes (#12985) * `backlight.c`: include `eeprom.h` (#13024) * Add changelog for 2021-05-29 Breaking Changes merge (#12939) * Add ChangeLog for 2021-05-29 Breaking Changes Merge: initial version * Add recent develop changes * Sort recent develop changes * Remove sections for ChibiOS changes per tzarc No ChibiOS changes this round. * Add and sort recent develop changes * add notes about keyboard moves/deletions * import changelog for PR 12172 Documents the change to BOOTMAGIC_ENABLE. * update section headings * re-sort changelog * add additional note regarding Bootmagic changes * remove changelog timestamp * update dates in main Breaking Changes docs * fix broken section anchors in previous changelogs * add link to backlight/eeprom patch to changelog * highlight some more changes * link PRs from section headers * Restore standard readme * run: qmk cformat --core-only
2021-05-26Document RGB_MATRIX_FRAMEBUFFER_EFFECTS (#12984)peepeetee
2021-05-21[Docs] Fix typos in audio config in main config page (#12928)shela
2021-05-20fix example code in docs/feature_rgblight.md (#12960)Takeshi ISHII
2021-05-20Add EE_HANDS documentation command example (#12730)Albert Y
* Add command example * Remove c tag Co-authored-by: filterpaper <filterpaper@localhost>
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-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-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-20Add additional info to PR Checklist (#12630)Drashna Jaelre
Co-authored-by: Nick Brassel <nick@tzarc.org>
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-14Add support for tab completion (#12411)Zach White
* Add support for tab completion * make flake8 happy * Add documentation
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-10 07:30:20 +0000