summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2020-07-07Docs: update ModemManager recommendation (#9328)Erovia
Instead of modifying the service file provided by the distro, use drop-in functionaly to explicitly specify the policy.
2020-07-05fixed link to Eclipse instructions (#9647)yanekm
2020-07-04add DIP_SWITCH_MATRIX_GRID support (#8772)Takeshi ISHII
* dipsw test on helix/rev2/sc/back:five_rows * add peek_matrix() to matrix_common.c * add DIP_SWITCH_MATRIX_GRID support to quantum/dip_switch.c * update docs/feature_dip_switch.md about DIP_SWITCH_MATRIX_GRID * Test end. remove test code. Revert "dipsw test on helix/rev2/sc/back:five_rows" This reverts commit 6d4304c74557597c9fb4d324f79c3ae4793ae874.
2020-07-04add SPLIT_HAND_MATRIX_GRID support (#8685)Takeshi ISHII
Co-authored-by: Danny <nooges@users.noreply.github.com>
2020-07-03Backlight docs wordsmithing (#9631)Ryan
2020-07-02Add movement hook to ps2_mouse (#8805)Manna Harbour
Process mouse movement in the keymap before it is sent to the host. Example uses include filtering noise, adding acceleration, and automatically activating a layer. To use, define the following function in your keymap: void ps2_mouse_moved_user(report_mouse_t *mouse_report);
2020-06-29[Docs] Japanese translation of docs/compatible_microcontrollers.md (#9518)umi
* add compatible_microcontrollers.md translation * update based on comment * update based on comment
2020-06-28[Update] Japanese translation of docs/cli.md and docs/cli_commands.md (#9536)Takeshi ISHII
* update docs/ja/cli.md * update docs/ja/cli_commands.md * Update docs/ja/cli.md Co-authored-by: shela <shelaf@users.noreply.github.com> * update docs/ja/cli_commands.md Co-authored-by: shela <shelaf@users.noreply.github.com>
2020-06-27[Docs] Japanese translation of docs/documentation_templates.md (#9523)umi
* add documentation_templates.md translation * update based on comment * update based on comment
2020-06-27[Docs] Japanese translation of docs/documentation_best_practices.md (#9522)umi
* add documentation_best_practices.md translation * update based on comment * update based on comment
2020-06-25[Docs] fix file path (#9540)shela
2020-06-24feat: add dvorak-fr as extra keymap (#9512)Guillaume Gérard
2020-06-25[Update] Japanese Translation of docs/feature_layers.md (#9537)Takeshi ISHII
* update docs/ja/feature_layers.md see https://github.com/qmk/qmk_firmware/pull/9492 * update original document's TAG
2020-06-24[Update] Japanese translation of ↵Takeshi ISHII
docs/newbs_building_firmware_configurator.md (#9395) * update docs/ja/newbs_building_firmware_configurator.md Following the original changes, docs/ja/newbs_building_firmware_configurator.md was divided into docs/ja/configurator_step_by_step.md and docs/ja/configurator_troubleshooting.md. * Update docs/ja/configurator_step_by_step.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/configurator_step_by_step.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/configurator_step_by_step.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/configurator_step_by_step.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/configurator_step_by_step.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/configurator_troubleshooting.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/configurator_troubleshooting.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/configurator_step_by_step.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/configurator_step_by_step.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/configurator_step_by_step.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/configurator_troubleshooting.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/newbs_building_firmware_configurator.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/configurator_troubleshooting.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/newbs_building_firmware_configurator.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/configurator_step_by_step.md Co-authored-by: shela <shelaf@users.noreply.github.com> Co-authored-by: shela <shelaf@users.noreply.github.com>
2020-06-23Add Hebrew keymap aliases (#9383)Joshua Diamond
* Add Hebrew keymap aliases * Use NBSP for internal space in box drawings * Apply suggestions from code review * More whitespace fixes * IL_DVAV, IL_DYOD and IL_VYOD were incorrect * Add IL_DEG, IL_MUL, IL_DIV * Hebrew is now ISO (no more BAE) * Use ISO left shift * Apply suggestions from code review * DYOD and VYOD were reversed in diagram. Oops!
2020-06-23[Docs] Japanese translation of docs/feature_layers.md (#9252)umi
* add feature_layers.md translation * update based on comment * update based on comment * update based on comment
2020-06-23fixed the layer limit of LT() (#9492)shela
2020-06-22[Update] Japanese Translation of docs/faq_build.md (#9458)Takeshi ISHII
* update docs/ja/faq_build.md * update docs/ja/faq_build.md to 0.9.10 * Update docs/ja/faq_build.md Co-authored-by: shela <shelaf@users.noreply.github.com> Co-authored-by: shela <shelaf@users.noreply.github.com>
2020-06-22[Update] Japanese translation of newbs.md (#9388)Takeshi ISHII
* update docs/ja/newbs.md * Update docs/ja/newbs.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/newbs.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/newbs.md Co-authored-by: shela <shelaf@users.noreply.github.com> Co-authored-by: shela <shelaf@users.noreply.github.com>
2020-06-22[Docs] Japanese translation of docs/feature_userspace.md (#9253)umi
* add feature_userspace.md translation * update based on comment
2020-06-22[Docs] Japanese translation of docs/feature_macros.md (#9137)umi
* add feature_macros.md translation * update based on comment * update based on comment
2020-06-22Improve keycode handling for RGB (#7677)Drashna Jaelre
Co-authored-by: drashna <drashna@live.com> Co-authored-by: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
2020-06-21[Docs] fix indentation (#9491)shela
2020-06-21update docs/ja/feature_bootmagic.md (#9459)Takeshi ISHII
2020-06-21update ja/hardware_keyboard_guidelines.md (#9457)Takeshi ISHII
2020-06-21[Update] Change Original TAGs of Japanese translations (#9453)Takeshi ISHII
* The TAGs of the original document has been updated to facilitate future verification. * docs/ja/driver_installation_zadig.md * docs/ja/feature_audio.md * docs/ja/feature_auto_shift.md * docs/ja/feature_bluetooth.md * docs/ja/hardware_avr.md * docs/ja/hardware_drivers.md * docs/ja/getting_started_make_guide.md * The TAG of the original document has been updated to facilitate future verification. * The TAG of the original document has been updated to facilitate future verification. * update docs/ja/feature_tap_dance.md
2020-06-21[Docs] Japanese translation of breaking_changes*.md (#8576)Takeshi ISHII
* add japanese translation 'docs/ja/breaking_changes.md' Note: this is cherry-pick from umi-umi's translation in PR #7248 * update ja/breaking_changes.md * update ja/breaking_changes.md, add ja/breaking_changes_instructions.md * translating ja/breaking_changes_instructions.md * translating ja/breaking_changes_instructions.md * translated ja/breaking_changes_instructions.md * update ja/breaking_changes.md, ja/breaking_changes_instructions.md Breaking change の訳語を「破壊的な変更」から「互換性を破る変更」に変更。 ただし、文中の用語としては、Breaking change をそのまま使用するむねドキュメントの導入部で 訳注でしめし、文中では、原語のまま使用する。 * update docs/ja/_summary.md * Update docs/ja/breaking_changes.md Co-Authored-By: shela <shelaf@users.noreply.github.com> * Update docs/ja/breaking_changes.md Co-Authored-By: shela <shelaf@users.noreply.github.com> * Update docs/ja/breaking_changes.md Co-Authored-By: shela <shelaf@users.noreply.github.com> * Update docs/ja/breaking_changes.md Co-Authored-By: shela <shelaf@users.noreply.github.com> * Update docs/ja/breaking_changes.md Co-Authored-By: shela <shelaf@users.noreply.github.com> * Update docs/ja/breaking_changes.md Co-Authored-By: shela <shelaf@users.noreply.github.com> * Update docs/ja/breaking_changes.md * update docs/ja/breaking_changes.md * update docs/ja/breaking_changes.md * update docs/ja/breaking_changes.md * update docs/ja/breaking_changes.md * update docs/ja/breaking_changes.md * Update docs/ja/breaking_changes_instructions.md Co-Authored-By: shela <shelaf@users.noreply.github.com> * Update docs/ja/breaking_changes_instructions.md Co-Authored-By: shela <shelaf@users.noreply.github.com> * update docs/ja/breaking_changes.md * Update docs/ja/breaking_changes_instructions.md Co-Authored-By: shela <shelaf@users.noreply.github.com> * Update docs/ja/breaking_changes_instructions.md * Update docs/ja/breaking_changes_instructions.md Co-Authored-By: shela <shelaf@users.noreply.github.com> * update docs/ja/breaking_changes_instructions.md * update docs/ja/breaking_changes_instructions.md * The base of the translation of docs/ja/breaking_changes_instructions.md was changed to 0.9.0. * The base of the translation of docs/ja/breaking_changes.md was changed to 0.9.0. * Update docs/ja/breaking_changes.md Co-authored-by: s-show <s1shimz@gmail.com> * update docs/ja/breaking_changes.md * Update docs/ja/breaking_changes_instructions.md Co-authored-by: shela <shelaf@users.noreply.github.com> * update docs/ja/breaking_changes.md * update docs/ja/breaking_changes.md Co-authored-by: umi-umi <57262844+umi-umi@users.noreply.github.com> Co-authored-by: shela <shelaf@users.noreply.github.com> Co-authored-by: s-show <s1shimz@gmail.com>
2020-06-21Update newbs MSYS2 pacman instructions (#9445)Ryan
2020-06-21Adding information to feature_encoders.md (#9486)AlexOConnorHub
Co-authored-by: Ryan <fauxpark@gmail.com>
2020-06-20[Docs] Improve Unicode documentation (#8676)Konstantin Đorđević
2020-06-20[Update] Files with Japanese translations related to #8822 (#9455)Takeshi ISHII
* The TAG of the original document has been updated to facilitate future verification. * The TAG of the original document has been updated to facilitate future verification. * The TAG of the original document has been updated to facilitate future verification.
2020-06-20Fix incorrect delay when setting WS2812 (and similar) leds (#9302)Joshua Diamond
* Fix incorrect delay when setting WS2812 (and similar) leds * Add documentation for WS2812_DELAY_MICROSECONDS * Remove improper cast to uint8_t Co-authored-by: Sergey Vlasov <sigprof@gmail.com> * Remove unneeded cast to uint8_t and correct math Co-authored-by: Sergey Vlasov <sigprof@gmail.com> * microseconds -> µs Co-authored-by: Ryan <fauxpark@gmail.com> * Make documentation better match the spec sheet. Co-authored-by: Ryan <fauxpark@gmail.com> * Rename macro to match spec sheet * Further correction to the delay maths for the SPI case. Co-authored-by: Joel Challis <git@zvecr.com> * Move ws2812_common.h to the drivers directory * Revert "Further correction to the delay maths for the SPI case." This reverts commit e61b56a2cfc7dfec9992a7a3af92afa50e5b8ec0. * Remove ws2812_setleds_pin(); consolidate ws2812.h Co-authored-by: Sergey Vlasov <sigprof@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Joel Challis <git@zvecr.com>
2020-06-20STM32 WS2812 Open Drain Configuration (#9414)Xelus22
* update docs stm32 only and applies to all 3 driver * cformat
2020-06-19Update docs/ja/feature_backlight.md: apply #9043's change (#9454)Takeshi ISHII
2020-06-18Standardize how unicode is processed (fixes #8768) (#8770)Jason Laqua
Co-authored-by: Konstantin Đorđević <vomindoraan@gmail.com>
2020-06-17Clean up Tap Dance docs (#9372)Ryan
* Clean up Tap Dance docs * Add heading IDs for translation
2020-06-15[Docs] Fix link to mod_tap.md in the one_shot_keys.md file (#9380)Reed
2020-06-15Delete trailing period in documentation (#9416)jems-lee
2020-06-12[Docs] Japanese translation of docs/feature_split_keyboard.md (#9031)umi
* add feature_split_keyboard.md translation * add header for git * update based on comment * update based on comment
2020-06-11Really fix Ubuntu/Debian setup when $PATH contains spaces (#9370)Sergey Vlasov
PR #9307 fixed the immediately visible problem (the command that was added to $HOME/.bashrc was incorrect because of missing quotes around paths with spaces). However, the modified command is still wrong - it captures the value of $PATH at the setup time, and the resulting command written out to $HOME/.bashrc will overwrite $PATH with that captured value, ignoring any changes in the environment. This may be especially important for WSL, where the initial value of $PATH in Linux includes everything which has been added to %PATH% on the Windows side; after adding that command to $HOME/.bashrc the WSL environment will no longer pick up any changes made by newly installed Windows software. Instead of that, use single quotes around the command, so that the environment variables are not expanded at the setup time, and the command that is added to $HOME/.bashrc becomes exactly this: PATH="$HOME/.local/bin:$PATH" This command will use the $HOME and $PATH environment variable values at the time the command is executed, not at the time the QMK setup is performed, so any further updates to $PATH are taken into account. Double quotes also ensure that the command is safe even if the values of those environment variables contain spaces.
2020-06-10Fix Ubuntu/Debian setup when $PATH contains spaces (#9307)neon4272
* Change `echo` to `export` * Add `export` as a note under the `echo` command * Remove note from last commit Co-authored-by: Ryan <fauxpark@gmail.com> * Update docs/newbs_getting_started.md Co-authored-by: Ryan <fauxpark@gmail.com> * Update docs/newbs_getting_started.md Add 1 line of whitespace under note Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
2020-06-10Add documentation for selecting an Arm MCU (#9046)Nick Brassel
* Initial doco write-up. * Update docs/platformdev_selecting_arm_mcu.md Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> Co-authored-by: Ryan <fauxpark@gmail.com>
2020-06-10[Docs] Fixed the hyperlink to `/users/_example/`. (#9326)precondition
2020-06-10Include `pointing_device_send` in docs (#9185)Drashna Jaelre
2020-06-10adds support for the atmega328 (#9043)itsnoteasy
Co-authored-by: Ryan <fauxpark@gmail.com>
2020-06-10[Docs] Japanese translation of docs/feature_wpm.md (#9254)umi
* add feature_wpm.md translation * update based on comment * update based on comment * update based on comment
2020-06-09Add OS compatibility matrix for basic keycodes (#8557)Ryan
2020-06-09[Update] Japanese translation of newbs_learn_more_resources.md (#9288)Takeshi ISHII
* Updated the Japanese translation of newbs_learn_more_resources.md Updated the Japanese translation of newbs_learn_more_resources.md to 0.9.0. * update docs/ja/newbs_learn_more_resources.md * update ja/newbs_learn_more_resources.md
2020-06-09[Update] Japanese translation of docs/newbs_testing_debugging.md. (#9286)Takeshi ISHII
* Updated the Japanese translation of newbs_testing_debugging.md. Updated the Japanese translation of newbs_testing_debugging.md to 0.9.0. * Update docs/ja/newbs_testing_debugging.md Co-authored-by: s-show <s1shimz@gmail.com> * Update docs/ja/newbs_testing_debugging.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/newbs_testing_debugging.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>
2020-06-08[Docs] Japanese translation of docs/feature_ps2_mouse.md (#9030)umi
* add feature_ps2_mouse.md translation * update based on comment * update based on comment * update based on comment * update based on comment