summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
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
2020-06-08[Docs] Japanese translation of docs/feature_terminal.md (#9033)umi
* add feature_terminal.md translation * add header for git * update based on comment
2020-06-07[Docs] Update udev rules to use TAG+="uaccess". (#8750)Pete Johanson
2020-06-07[Docs] Japanese translation of docs/feature_swap_hands.md (#9032)umi
* add feature_swap_hands.md translation * update based on comment * back to original translation
2020-06-05The TAGs of the original document has been updated to facilitate future ↵Takeshi ISHII
verification. (#9285)
2020-06-01[Docs] Japanese translation of docs/feature_mouse_keys.md (#8992)umi
* add feature_mouse_keys.md translation * update based on comment * update based on comment * update based on comment * update based on comment * update based on comment
2020-06-01`French (Belgium)` was missing (#9245)Kimat Boven
2020-06-01Option to allow lighting layers when RGB Lighting is off (#9051)Joshua Diamond
2020-05-302020 May 30 Breaking Changes Update (#9215)James Young
* Branch point for 2020 May 30 Breaking Change * Migrate `ACTION_LAYER_TOGGLE` to `TG()` (#8954) * Migrate `ACTION_MODS_ONESHOT` to `OSM()` (#8957) * Migrate `ACTION_DEFAULT_LAYER_SET` to `DF()` (#8958) * Migrate `ACTION_LAYER_MODS` to `LM()` (#8959) * Migrate `ACTION_MODS_TAP_KEY` to `MT()` (#8968) * Convert V-USB usbdrv to a submodule (#8321) * Unify Tap Hold functions and documentation (#8348) * Changing board names to prevent confusion (#8412) * Move the Keyboardio Model01 to a keyboardio/ subdir (#8499) * Move spaceman keyboards (#8830) * Migrate miscellaneous `fn_actions` entries (#8977) * Migrate `ACTION_MODS_KEY` to chained mod keycodes (#8979) * Organizing my keyboards (plaid, tartan, ergoinu) (#8537) * Refactor Lily58 to use split_common (#6260) * Refactor zinc to use split_common (#7114) * Add a message if bin/qmk doesn't work (#9000) * Fix conflicting types for 'tfp_printf' (#8269) * Fixed RGB_DISABLE_AFTER_TIMEOUT to be seconds based & small internals cleanup (#6480) * Refactor and updates to TKC1800 code (#8472) * Switch to qmk forks for everything (#9019) * audio refactor: replace deprecated PLAY_NOTE_ARRAY (#8484) * Audio enable corrections (2/3) (#8903) * Split HHKB to ANSI and JP layouts and Add VIA support for each (#8582) * Audio enable corrections (Part 4) (#8974) * Fix typo from PR7114 (#9171) * Augment future branch Changelogs (#8978) * Revert "Branch point for 2020 May 30 Breaking Change"
2020-05-27Documentation for keymap_extras (#9194)Ryan
2020-05-26[CLI] Add a subcommand for getting information about a keyboard (#8666)Zach White
You can now use `qmk info` to get information about keyboards and keymaps. Co-authored-by: Erovia <Erovia@users.noreply.github.com>
2020-05-26[Docs] Japanese translation of docs/feature_pointing_device.md (#8993)umi
* add feature_pointing_device.md translation * update based on comment * update based on comment * update based on comment * update based on comment
2020-05-25Fix capitalisation of "GitHub" (#9184)Ryan
2020-05-23Fixed the indentation of the sample code in feature_pointing_device docs (#9177)Takeshi ISHII
* Fixed the indentation of the sample code in docs/feature_pointing_device.md sample. * Update docs/feature_pointing_device.md Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Joel Challis <git@zvecr.com>
2020-05-22Update ARM split keyboard docs (#9160)Joel Challis
* Update ARM split keyboard docs * Update docs/serial_driver.md Co-authored-by: Nick Brassel <nick@tzarc.org> Co-authored-by: Nick Brassel <nick@tzarc.org>
2020-05-21ARM split - Add uart half duplex transport support (#7987)Joel Challis
* ARM split - Add uart half duplex transport support * Fix for f103 * initial full duplex pass * partially remove full duplex * Correct speeds within driver docs Co-authored-by: Nick Brassel <nick@tzarc.org> Co-authored-by: Nick Brassel <nick@tzarc.org>
2020-05-21[Docs] newbs_flashing.md: place bootloader instructions before Toolbox intro ↵Ryan
(#9077) * newbs_flashing.md: place bootloader instructions before Toolbox intro * Update docs/newbs_flashing.md * More wordsmithing, point ARM users at Discord if all else fails * Link Discord
2020-05-21Allow for overriding RAW endpoint usage page and ID. (#8834)Nick Brassel
* Allow for overriding RAW endpoint usage page and ID. * Move usb_descriptor_common.h. * Docs update.
2020-05-20CLI: Improve experience when running `qmk setup` on FreeBSD. (#8798)Pete Johanson
* CLI: Improve experience when running `qmk setup` on FreeBSD. * Install the `avrdude` package as well. * Switch to installing python packages w/ `--user` flag. * Basic getting started sections for FreeBSD. * Update `util/freebsd_install.sh` for root/non-root branches. * Add ID to doc section. Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com> * Add ID to another docs section. Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com> * Use `; then` in script for consistency. Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com> * Updated to use sudo in one shot if available. * Apply suggestions from code review Co-authored-by: Erovia <Erovia@users.noreply.github.com> * Style fixes for latest version in master. * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: skullydazed <skullydazed@users.noreply.github.com> Co-authored-by: Erovia <Erovia@users.noreply.github.com> Co-authored-by: Ryan <fauxpark@gmail.com>
2020-05-19Reintegrate previous docker docs (#9084)Joel Challis
2020-05-18Streamline the macos install processskullY
2020-05-18[Docs] Japanese translation of docs/feature_led_matrix.md (#8991)umi
* add feature_led_matrix.md translation * update based on comment * update based on comment