summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2021-10-15[Docs] Clean up reference_info_json.md (#14806)Ryan
2021-10-09Update Japanese document (#14766)shela
2021-10-09Update Japanese document (#14767)shela
2021-10-09Update Japanese document (#14769)shela
2021-10-08Translate keycodes us ansi shifted (#13820)s-show
* copy "keycodes_us_ansi_shifted.md" to docs/ja. * Add japanese translation "docs/keycodes_us_ansi_shifted.md". * Apply suggestions from code review Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/keycodes_us_ansi_shifted.md 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-10-07Fix link from feature_tap_dance.md to tapping term settings (#14741)precondition
2021-10-06More PR checklist updates (#14705)Nick Brassel
* Wording, clarification. * Apply suggestions from code review Co-authored-by: Mikkel Jeppesen <2756925+Duckle29@users.noreply.github.com> Co-authored-by: Mikkel Jeppesen <2756925+Duckle29@users.noreply.github.com>
2021-10-05Add clarification for licensing. (#14704)Nick Brassel
* Add clarification for licensing. * Errr, v2.
2021-10-04Document examples on intercepting Mod-Tap (#14502)Albert Y
Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Dasky <32983009+daskygit@users.noreply.github.com> Co-authored-by: filterpaper <filterpaper@localhost>
2021-10-01[Docs] update Japanese translation of mod_tap.md (#13981)umi
* update mod_tap.md translation * add id on config_options.md and update text based on comments
2021-10-01Fix documentation for NO_HAPTIC_MOD and NO_HAPTIC_FN features. (#14180)Purdea Andrei
2021-09-29[Core] Fix "6kro enable" and clarify naming (#14563)Drashna Jaelre
* Fix USB_6KRO_ENABLE compilation errors * Add info to docs * Rename define to be more accurate * Remove unused rule * Refixe docs
2021-09-24[Docs] Broken FAQ hyperlink (#14578)clickclackwho
2021-09-24[Docs] update Japanese translation of pr_checklist.md (#13693)umi
* update pr_checklist.md translation * update file based on comments * add id on feature_led_indicators.md and update text based on comments * update file based on comments * update file based on comment
2021-09-23[Docs] update Japanese translation of feature_backlight.md (#14403)umi
* update feature_backlight.md translation * update file based on comments
2021-09-23[Docs] update Japanese translation of feature_advanced_keycodes.md (#14309)umi
* update feature_advanced_keycodes.md translation * update file based on comments
2021-09-23[Docs] update Japanese translation of isp_flashing_guide.md (#13700)umi
* update isp_flashing_guide.md translation * update isp_flashing_guide.md translation * correct url * trim remaining merge identifier
2021-09-23[Docs] update Japanese translation of feature_leader_key.md (#13669)umi
* update feature_leader_key.md translation * update file based on comments * update text based on comments
2021-09-23[Docs] update Japanese translation of one_shot_keys.md (#13656)umi
* update one_shot_keys.md translation * update one_shot_keys.md translation * correct paramter for function * add change of #13754
2021-09-21[Docs] update suspend_*_user examples (#14542)Dasky
2021-09-21[Docs] Modify encoder_update_user example to return false (#14541)Dasky
2021-09-20Doc Fixes & Custom Matrix Fix (#14526)XScorpion2
2021-09-19[Docs] fix wrong directory for RGB Matrix animations (#14494)David Xia
2021-09-15[Docs] add sync options heading, update led indicators (#14441)Dasky
Co-authored-by: Ryan <fauxpark@gmail.com>
2021-09-14[Docs] fixed incorrect amount of steps for oled usage (#13519)vsrivastava
changed line 21 from saying "three steps" to "two steps" as there are only two steps Co-authored-by: feynmantf <46390109+feynmantf@users.noreply.github.com>
2021-09-12update compatible_microcontrollers.md translation (#14401)umi
2021-09-12Remove width, height and key_count from info.json (#14274)Ryan
2021-09-10Change USBasp and bootloadHID bootloaders to lowercase (#14354)Ryan
2021-09-10Align rgb/led matrix docs with current behaviour (#14367)Joel Challis
2021-09-09Bugfix for Joystick and JSON schema (#14295)Ryan
2021-09-05Highlight keycode (#14317)Niko Wenselowski
This should make it consistent with other docs and hopefully will make less people miss this detail.
2021-09-05[Core] Add `is_oled_scrolling` (#14305)JayceFayne
2021-09-04Fix Space Cadet md link (#14300)JayceFayne
2021-09-01[Docs] Update path to keycode.h (#14263)qieq
2021-08-31Documentation: Fix links in key overrides (#14228)coliss86
Co-authored-by: Joel Challis <git@zvecr.com>
2021-08-29move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230)Zach White
2021-08-29Bootmagic lite docs clarity. (#14204)Nick Brassel
2021-08-292021Q3 pre-merge `develop` changelog, keyboard aliases (#14198)Nick Brassel
* Initial changelog. * Data driven. * Submodule update. * Updated breaking changes docs. * Aliases. * Aliases.
2021-08-27[Docs] Add examples to RGB Matrix Indicators docs (#12797)Drashna Jaelre
2021-08-24[Core] Refactor OLED to allow easy addition of other types (#13454)Xelus22
* add docs * core changes * update keyboards to new OLED * updated users to new OLED * update layouts to new OLED * fixup docs * drashna's suggestion * fix up docs * new keyboards with oled * core split changes * remaining keyboard files * Fix The Helix keyboards oled options * reflect develop Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: mtei <2170248+mtei@users.noreply.github.com>
2021-08-24adding uf2 flash support for blackpill 401 (#13968)Path Nirvana
* adding uf2 flash support for blackpill 401 * forgot to add blackpill to keyboard header file * making changes requested by drashna * fixing tzarc s comments * removing the keyboard * undo the change to dactyl_manuform.h
2021-08-22Make solo half of split keyboards (more) usable. (#13523)Joakim Tufvegren
* Make solo half of split keyboards (more) usable. Using only one half of a split keyboard (that's using the split_common framework to communicate) is not a great experience, since several read timeouts per scan cycle cause an unusably slow scan rate. This change blocks all split communication attempts for 500 ms (configurable) after an error occurs, causing the scan rate to become at least _more_ usable, but might need some tweaking to work fully on most keyboards. One read timeout still needs to occur after the 500 ms has passed, and if that timeout isn't low enough, some scan cycles may still be too slow. * Fix lint complaint. * Require 25 consecutive comm errors to see comms as disconnected. The number of max errors can be overridden by defining `SPLIT_MAX_CONNECTION_ERRORS`. * Add comments to new defines, and ability to disable disconnection check. Also increase `SPLIT_MAX_CONNECTION_ERRORS` to 40, since it's divisible by most relevant numbers for the description. * Make lint happy ...again * Only update `connection_check_timer` when needed. * Add new defines to split keyboard documentation. * Move connection timeout logic to transport.c, add `is_transport_connected`. * Use split_common disconnection logic in matrix.c. Instead of doing more or less the same thing twice. * Move disconnection logic to `transport_master`. Is a cleaner implementation, and causes the scan rate while disconnected to increase instead of decrease. * Lint fixes. * Lower default `SERIAL_USART_TIMEOUT` to 20 ms. The read timeout must be low enough to not cause exessively long scan cycles when using a solo split half. 10 ms was determined from testing to work fine even with the slowest defined baudrate of 19200 (5 ms was too low for that case), so 20 ms should be fine for most cases. * Remove `SERIAL_USART_TIMEOUT` from ergodox_infinity/config.h Was somewhat mistakenly included in an earlier PR. * Fix building with `USE_I2C`. * Reduce built firmware size. Not really sure why this works, the idea was taken from tzarc's work on split disconnection. * Tweak and improve opt-out for split disconnection logic. There are now two ways to opt out from this feature: * Set `SPLIT_MAX_CONNECTION_ERRORS` to 0. This will completely disable the connection status checks (also affects the slave matrix reset logic in matrix.c, though). * Set `SPLIT_CONNECTION_CHECK_TIMEOUT` to 0. This will only disable the communication throttling while disconnected. Will make the firmware smaller. * Make split disconnection logic work with custom transports. Includes a fallback implementation for keyboards using a custom split_util.c but not a custom matrix.c (currently no such keyboard seems to be merged, though). * Remove unnecessary include of timer.h Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Joel Challis <git@zvecr.com>
2021-08-20Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-08-20[Core] [Docs] Remove travis-ci references (#13916)Spaceman
2021-08-19Added right vs left specific pin assignments for dip switch (#13074)XScorpion2
* Added right vs left specific pin assignments for dip switch * Update feature_dip_switch.md * Ran formatting tools
2021-08-18Allow for removal of hysteresis on 4x encoders (#13698)tucvbif
* Remove hysteresis on 4x encoders Sometimes, controller skips encoder pulses and when it returns to default position, the encoder_pulses variable isn't equals 0. And when I turn encoder in opposite direciton, it skips first click becase of encoder_pulses crosses zero. To prevent this, I add the ENCODER_DEFAULT_POS constant, and reset encoder_pulses into 0 when the state variable equals ENCODER_DEFAULT_POS. * Documentation for ENCODER_DEFAULT_POS
2021-08-18Add a toggle key for GUI On/Off in Magic feature (#13830)Drashna Jaelre
2021-08-18`--parallel` improvements (#13800)ruro
* improve make parallel jobs support * document the --parallel option * disable the output-sync for interactive targets
2021-08-18Digitizer HID interface : absolute coordinates for mouse cursor (#12851)a-chol
* Add digitizer HID interface for setting the mouse cursor position at absolute screen coordinates. Tested on Pro Micro, Proton C and Blackpill. * Update docs/feature_digitizer.md Co-authored-by: Ryan <fauxpark@gmail.com> * Update tmk_core/protocol/usb_descriptor.c Co-authored-by: Ryan <fauxpark@gmail.com> * Add missing copyrights Add V-USB support * Add support for digitizer dedicated endpoint for lufa and chibios. Fix formatting issues Move digitizer_task definition to the feature's base implementation file * Run cformat on modified files * Change digitizer report usage to Digitizer instead of Pen to avoid pointer disappearing on Windows. * Update tmk_core/protocol/vusb/vusb.c Co-authored-by: Ryan <fauxpark@gmail.com> * Run cformat from docker image * Remove send_digitizer from host_driver_t and instead rely on the declaration being the interface to the implementation in each HW-specific usb implementation. * Fix build : send_digitizer shouldn't be static in vusb and add weak-linkage implementation for tests without usb implementation * Change digitizer user interface to match pointing device's * Update documentation with new API Co-authored-by: a-chol <nothing@none.com> Co-authored-by: Ryan <fauxpark@gmail.com>
2021-08-18Steno combinedkeys (#12538)freqmod
* Add support for steno keys that press adjacent keys simultaniously * Add some docs for steno combined keys