summaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* Clean up Tap Dance docs (#9372)Ryan2020-06-171-272/+260
| | | | | * Clean up Tap Dance docs * Add heading IDs for translation
* [Docs] Fix link to mod_tap.md in the one_shot_keys.md file (#9380)Reed2020-06-151-1/+1
|
* Delete trailing period in documentation (#9416)jems-lee2020-06-151-1/+1
|
* [Docs] Japanese translation of docs/feature_split_keyboard.md (#9031)umi2020-06-121-0/+232
| | | | | | | | | * add feature_split_keyboard.md translation * add header for git * update based on comment * update based on comment
* Really fix Ubuntu/Debian setup when $PATH contains spaces (#9370)Sergey Vlasov2020-06-111-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | 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.
* Fix Ubuntu/Debian setup when $PATH contains spaces (#9307)neon42722020-06-101-1/+1
| | | | | | | | | | | | | | | | | | | | | * 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>
* Add documentation for selecting an Arm MCU (#9046)Nick Brassel2020-06-102-0/+59
| | | | | | | | | | | | | | * 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>
* [Docs] Fixed the hyperlink to `/users/_example/`. (#9326)precondition2020-06-101-1/+1
|
* Include `pointing_device_send` in docs (#9185)Drashna Jaelre2020-06-101-1/+6
|
* adds support for the atmega328 (#9043)itsnoteasy2020-06-104-4/+5
| | | Co-authored-by: Ryan <fauxpark@gmail.com>
* [Docs] Japanese translation of docs/feature_wpm.md (#9254)umi2020-06-101-0/+24
| | | | | | | | | * add feature_wpm.md translation * update based on comment * update based on comment * update based on comment
* Add OS compatibility matrix for basic keycodes (#8557)Ryan2020-06-091-199/+206
|
* [Update] Japanese translation of newbs_learn_more_resources.md (#9288)Takeshi ISHII2020-06-091-15/+24
| | | | | | | | | * 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
* [Update] Japanese translation of docs/newbs_testing_debugging.md. (#9286)Takeshi ISHII2020-06-091-14/+11
| | | | | | | | | | | | | | | | | | | | * 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>
* [Docs] Japanese translation of docs/feature_ps2_mouse.md (#9030)umi2020-06-081-0/+293
| | | | | | | | | | | * add feature_ps2_mouse.md translation * update based on comment * update based on comment * update based on comment * update based on comment
* [Docs] Japanese translation of docs/feature_terminal.md (#9033)umi2020-06-081-0/+112
| | | | | | | * add feature_terminal.md translation * add header for git * update based on comment
* [Docs] Update udev rules to use TAG+="uaccess". (#8750)Pete Johanson2020-06-071-15/+12
|
* [Docs] Japanese translation of docs/feature_swap_hands.md (#9032)umi2020-06-071-0/+36
| | | | | | | * add feature_swap_hands.md translation * update based on comment * back to original translation
* The TAGs of the original document has been updated to facilitate future ↵Takeshi ISHII2020-06-054-8/+8
| | | | verification. (#9285)
* [Docs] Japanese translation of docs/feature_mouse_keys.md (#8992)umi2020-06-011-0/+127
| | | | | | | | | | | | | * 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
* `French (Belgium)` was missing (#9245)Kimat Boven2020-06-011-0/+1
|
* Option to allow lighting layers when RGB Lighting is off (#9051)Joshua Diamond2020-06-012-0/+6
|
* 2020 May 30 Breaking Changes Update (#9215)James Young2020-05-309-99/+349
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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"
* Documentation for keymap_extras (#9194)Ryan2020-05-272-0/+80
|
* [CLI] Add a subcommand for getting information about a keyboard (#8666)Zach White2020-05-261-2/+35
| | | | | You can now use `qmk info` to get information about keyboards and keymaps. Co-authored-by: Erovia <Erovia@users.noreply.github.com>
* [Docs] Japanese translation of docs/feature_pointing_device.md (#8993)umi2020-05-261-0/+49
| | | | | | | | | | | * add feature_pointing_device.md translation * update based on comment * update based on comment * update based on comment * update based on comment
* Fix capitalisation of "GitHub" (#9184)Ryan2020-05-2538-63/+63
|
* Fixed the indentation of the sample code in feature_pointing_device docs (#9177)Takeshi ISHII2020-05-231-9/+6
| | | | | | | | | * 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>
* Update ARM split keyboard docs (#9160)Joel Challis2020-05-223-5/+26
| | | | | | | | | * 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>
* ARM split - Add uart half duplex transport support (#7987)Joel Challis2020-05-212-0/+60
| | | | | | | | | | | | | | | * 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>
* [Docs] newbs_flashing.md: place bootloader instructions before Toolbox intro ↵Ryan2020-05-211-40/+42
| | | | | | | | | | | | (#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
* Allow for overriding RAW endpoint usage page and ID. (#8834)Nick Brassel2020-05-211-1/+5
| | | | | | | * Allow for overriding RAW endpoint usage page and ID. * Move usb_descriptor_common.h. * Docs update.
* CLI: Improve experience when running `qmk setup` on FreeBSD. (#8798)Pete Johanson2020-05-201-2/+19
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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>
* Reintegrate previous docker docs (#9084)Joel Challis2020-05-192-1/+50
|
* Streamline the macos install processskullY2020-05-183-21/+9
|
* [Docs] Japanese translation of docs/feature_led_matrix.md (#8991)umi2020-05-181-0/+95
| | | | | | | * add feature_led_matrix.md translation * update based on comment * update based on comment
* [Docs] Japanese translation of docs/feature_layouts.md (#8949)umi2020-05-181-0/+114
| | | | | | | * add feature_layouts.md translation * update based on comment * update based on comment
* [Docs] Japanese translation of docs/feature_thermal_printer.md (#9034)umi2020-05-181-0/+15
| | | * add feature_thermal_printer.md translation
* [Docs] Japanese translation of docs/feature_velocikey.md (#9035)umi2020-05-181-0/+35
| | | | | | | * add feature_velocikey.md translation * update based on comment * update based on comment
* [Docs] Japanese translation of docs/feature_leader_key.md (#8950)umi2020-05-181-0/+151
| | | | | | | | | | | | | * 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
* Add SPI 25xx EEPROM support. (#8780)Nick Brassel2020-05-191-5/+24
|
* Add query functions for RGB Light and RGB Matrix (#8960)Drashna Jaelre2020-05-182-12/+18
| | | | | | | | | | | | | * 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
* [Docs] Clarify layer transparency keymap.md (#9081)Nick Blyumberg2020-05-161-4/+16
| | | | | | | | | | | | | | | | | | * 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
* Improve stock bootloader list (#9067)Ryan2020-05-131-6/+12
| | | | | | | | | | | | | * 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
* One shot support for swap hands (#8590)Zsolt Parragi2020-05-142-0/+2
| | | | | | | | | | | | | | | | 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
* Allow expanding from 8 to 32 RGB Lighting Layers (#8941)Joshua Diamond2020-05-132-0/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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>
* fixed typo for clear lcd screen function in hd44780 docs (#9086)floookay2020-05-132-2/+2
| | | | | | | * fixed typo for clear lcd screen function brought to attention by #9085 * fixed typo for clear lcd screen function (ja docs)
* Docs: fix links in feature_hd44780.md (#9053)James Young2020-05-091-2/+2
| | | The referenced site was moved.
* New RGB Lighting effect: Twinkle (#8887)Joshua Diamond2020-05-091-2/+9
| | | | | | | | | | | | | * 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
* Add ability to blink lighting layer for a specified duration (#8760)Joshua Diamond2020-05-092-3/+44
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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>
generated by cgit v1.2.3 (git 2.25.1) at 2024-12-28 08:53:25 +0000