summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
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
2020-05-18[Docs] Japanese translation of docs/feature_layouts.md (#8949)umi
* add feature_layouts.md translation * update based on comment * update based on comment
2020-05-18[Docs] Japanese translation of docs/feature_thermal_printer.md (#9034)umi
* add feature_thermal_printer.md translation
2020-05-18[Docs] Japanese translation of docs/feature_velocikey.md (#9035)umi
* add feature_velocikey.md translation * update based on comment * update based on comment
2020-05-18[Docs] Japanese translation of docs/feature_leader_key.md (#8950)umi
* add feature_leader_key.md translation * update based on comment * set link as lang dir * update based on comment * update based on comment * update based on comment
2020-05-19Add SPI 25xx EEPROM support. (#8780)Nick Brassel
2020-05-18Add query functions for RGB Light and RGB Matrix (#8960)Drashna Jaelre
* Add additional query functions for RGBLIGHT * Add additional query functions for RGB Matrix * Change names of enable check functions * Fix macro for rgb matrix takeover of rgblight functions * Add documentation for rgb_matrix_get_hsv() * Add *_get_hsv function to rgblight
2020-05-16[Docs] Clarify layer transparency keymap.md (#9081)Nick Blyumberg
* Revised the grammar and clarity of the Layer Precedence and Transparency * Update docs/keymap.md * Update docs/keymap.md * Update docs/keymap.md * Update docs/keymap.md * Update docs/keymap.md * Update docs/keymap.md * Update docs/keymap.md
2020-05-13Improve stock bootloader list (#9067)Ryan
* Improve stock bootloader list * Switch version numbers on USB64/128 bootloaders * Unix line endings for PS2AVRGB bootloader * Update PS2AVRGB bootloader to 1.0.1 * Also mention bootloader rule * Didn't need to change the links
2020-05-14One shot support for swap hands (#8590)Zsolt Parragi
This commits add the SH_OS keycode, which works similarly to one shot layers: * while pressed, the keyboard is swapped * if no keys were pressed while it was pressed, the next key press is swapped SH_OS also supports chaining with one shot layers: OSL(x) + SH_OS + key interprets the key press on the oneshot layer. The ONESHOT_TIMEOUT setting used by one shot keys and layers is also used by oneshot swap hands. In the above chaining scenario the timeout of the oneshot layer is reset when swap hands is activated. Resolves #2682
2020-05-13Allow expanding from 8 to 32 RGB Lighting Layers (#8941)Joshua Diamond
* Allow 16 lighting layers * Require #define RGBLIGHT_LAYERS_16 to enable 16 layers * Override RGBLIGHT_MAX_LAYERS to set maximum number of lighting layers * Enforce lower bound on RGBLIGHT_MAX_LAYERS Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Fix an error in the check for valid RGBLIGHT_MAX_LAYERS * Don't use bitfield / PACKED, as it causes bloat * Update documentation re: up to 32 lighting layers * Run cformat * Add note about increasing FW size in docs/config_options.md Co-authored-by: Drashna Jaelre <drashna@live.com> * Remove no-longer-valid comment * Add doc note that split sync will be slower Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> Co-authored-by: Drashna Jaelre <drashna@live.com>
2020-05-13fixed typo for clear lcd screen function in hd44780 docs (#9086)floookay
* fixed typo for clear lcd screen function brought to attention by #9085 * fixed typo for clear lcd screen function (ja docs)
2020-05-09Docs: fix links in feature_hd44780.md (#9053)James Young
The referenced site was moved.
2020-05-09New RGB Lighting effect: Twinkle (#8887)Joshua Diamond
* Add twinkle RGB Lighting effect * 2nd twinkle algo - double-buffering * Further refinement: Per-LED twinkle * Add documentation for Twinkle RBG Lighting mode * Bias twinkle saturation closer to the set value * Fix whitespace
2020-05-09Add ability to blink lighting layer for a specified duration (#8760)Joshua Diamond
* Implement momentarily blink of lighting layers * Refactor spidey3 userspace to use rgb layer blink * Remove un-necessary line from example in documentation * Revert "Refactor spidey3 userspace to use rgb layer blink" This reverts commit 831649bb680c41c6d663ae6fa86d13f4f8bebdd8. * Adds a missing bit of documentation about lighting layer blink * Update docs/feature_rgblight.md per suggestions Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> * Update docs/feature_rgblight.md per suggestions Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> * Update docs/feature_rgblight.md per suggestions Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> * cformat, as suggested Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
2020-05-02Add redirect for old getting started links (#8987)Joel Challis
2020-05-01[Documentation] Added raw hid documentation page (#7640)Ahmed Elshafey
* Added raw hid feature documentation page * Update docs/feature_rawhid.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/feature_rawhid.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/feature_rawhid.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/features.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * added feature_rawhid.md to _summary.md in docs * fixed _summary.md order * Update docs/feature_rawhid.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update feature_rawhid.md Removed the useless bit about finding usage page and usage. * Update feature_rawhid.md * Update docs/feature_rawhid.md Co-Authored-By: Nick Brassel <nick@tzarc.org> * Update docs/feature_rawhid.md Co-Authored-By: Nick Brassel <nick@tzarc.org> * Update docs/feature_rawhid.md Co-Authored-By: Nick Brassel <nick@tzarc.org> * Update docs/feature_rawhid.md Co-Authored-By: Nick Brassel <nick@tzarc.org> * Remove teensy client, small origanization fixes * Fixed merge conflicts Removed features.md Updated _summary.md with new format and added RAW HID entry under Software Features * Added rawhid feature page Messy is what you get when you don't do things right the first time Co-authored-by: fauxpark <fauxpark@gmail.com> Co-authored-by: Nick Brassel <nick@tzarc.org>
2020-05-01[Docs] Japanese translation of docs/feature_key_lock.md (#8948)umi
* add feature_key_lock.md translation * update based on comment * set link as lang dir
2020-05-01[Docs] Japanese translation of docs/feature_haptic_feedback.md (#8874)umi
* add feature_haptic_feedback.md translation * update based on comment * update based on comment
2020-04-29add 'togglePin' convenience function (#8734)JohSchneider
* add 'togglePin' conveniance function for AVR and chibios * drop outmost parantheses Co-Authored-By: Konstantin Đorđević <vomindoraan@gmail.com> * toggle pin on avrs toggle a pin configured as output by writing the corresponding bit to the PIN register Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * togglepin: add documentation for newly added function * Update docs/internals_gpio_control.md Co-Authored-By: Konstantin Đorđević <vomindoraan@gmail.com> * on AVR: use PORTD to toggle the output ... since not all MCUs support toggling through writing to PIN Co-Authored-By: Ryan <fauxpark@gmail.com> Co-authored-by: Johannes <you@example.com> Co-authored-by: Konstantin Đorđević <vomindoraan@gmail.com> Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> Co-authored-by: Ryan <fauxpark@gmail.com>
2020-04-29Add SPI master for ChibiOS/ARM. (#8779)Nick Brassel
2020-04-29Edit Unit Testing Documentation (#8961)Alexander Hart
2020-04-27Update and try to clarify the CLI installation on Linux (#8783)Erovia
* Update and try to clarify the CLI installation on Linux * Update commands, add note for Debian/Ubuntu * Update docs/newbs_getting_started.md Co-Authored-By: Joel Challis <git@zvecr.com> Co-authored-by: Joel Challis <git@zvecr.com>
2020-04-27[Docs] Japanese translation of docs/feature_grave_esc.md (#8873)umi
* add feature_grave_esc.md translation * update based on comment * update based on comment * update based on comment * update based on comment * update based on comment
2020-04-27[Docs] Japanese translation of docs/feature_hd44780.md (#8875)umi
* add feature_hd44780.md translation * update based on comment * update based on comment * update based on comment
2020-04-26[Docs] Japanese translation of docs/feature_dynamic_macros.md (#8842)umi
* add feature_dynamic_macros.md translation * add header * add header * update based on comment * update based on comment
2020-04-23fix sample code indent in feature_encoders.md (#8883)Takeshi ISHII
2020-04-20[Docs] Japanese translation of docs/feature_encoders.md (#8843)umi
* add feature_encoders.md translation * update based on comment
2020-04-20[Docs] Japanese translation of docs/feature_command.md (#8672)umi
* add feature_command.md translation * update based on comment
2020-04-19[Docs] Fixed minor typos (#8860)Chris Ko
2020-04-19Add a syllabus to guide people who are learning QMK (#8816)skullydazed
2020-04-18Move everything to Python 3.6 (#8835)skullydazed
2020-04-18Document the Proton C pins for manual Pro Micro conversion (#7043)skullydazed