aboutsummaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* 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>
* Add redirect for old getting started links (#8987)Joel Challis2020-05-021-1/+2
|
* [Documentation] Added raw hid documentation page (#7640)Ahmed Elshafey2020-05-012-0/+66
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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>
* [Docs] Japanese translation of docs/feature_key_lock.md (#8948)umi2020-05-011-0/+27
| | | | | | | * add feature_key_lock.md translation * update based on comment * set link as lang dir
* [Docs] Japanese translation of docs/feature_haptic_feedback.md (#8874)umi2020-05-011-0/+163
| | | | | | | * add feature_haptic_feedback.md translation * update based on comment * update based on comment
* add 'togglePin' convenience function (#8734)JohSchneider2020-04-291-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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>
* Add SPI master for ChibiOS/ARM. (#8779)Nick Brassel2020-04-291-1/+18
|
* Edit Unit Testing Documentation (#8961)Alexander Hart2020-04-291-1/+1
|
* Update and try to clarify the CLI installation on Linux (#8783)Erovia2020-04-271-3/+14
| | | | | | | | | | | * 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>
* [Docs] Japanese translation of docs/feature_grave_esc.md (#8873)umi2020-04-271-0/+37
| | | | | | | | | | | | | * 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
* [Docs] Japanese translation of docs/feature_hd44780.md (#8875)umi2020-04-271-0/+62
| | | | | | | | | * add feature_hd44780.md translation * update based on comment * update based on comment * update based on comment
* [Docs] Japanese translation of docs/feature_dynamic_macros.md (#8842)umi2020-04-261-0/+71
| | | | | | | | | | | * add feature_dynamic_macros.md translation * add header * add header * update based on comment * update based on comment
* fix sample code indent in feature_encoders.md (#8883)Takeshi ISHII2020-04-232-2/+2
|
* [Docs] Japanese translation of docs/feature_encoders.md (#8843)umi2020-04-201-0/+81
| | | | | * add feature_encoders.md translation * update based on comment
* [Docs] Japanese translation of docs/feature_command.md (#8672)umi2020-04-201-0/+56
| | | | | * add feature_command.md translation * update based on comment
* [Docs] Fixed minor typos (#8860)Chris Ko2020-04-192-7/+7
|
* Add a syllabus to guide people who are learning QMK (#8816)skullydazed2020-04-192-0/+71
|
* Move everything to Python 3.6 (#8835)skullydazed2020-04-183-7/+7
|
* Document the Proton C pins for manual Pro Micro conversion (#7043)skullydazed2020-04-181-6/+63
|
* Remove Atmel FLIP from install scripts and documentation (#8822)Ryan2020-04-1711-40/+0
|
* [Docs] Japanese translation of docs/feature_combo.md (#8671)umi2020-04-151-0/+108
| | | | | | | | | * add feature_combo.md translation * change tiny word * update based on comment * update based on comment
* Add missing repository name to qmk setup w/ github (#8792)mimkorn2020-04-141-1/+1
| | | Using just qmk setup <github_username> would fail w/ "Could not find repo github.com/<username>, whereas the repo is actually after another slash after the user name. Can consider changing code to add the default forked repo name if slash is not detected in the arg.
* [Docs] Japanese translation of docs/feature_dip_switch.md (#8673)umi2020-04-131-0/+95
| | | | | | | * add git_dip_switch.md translation * update based on comment * update based on comment
* Fix AVR SPI parameter configuration, remove timeouts due to sync protocol. ↵Nick Brassel2020-04-131-19/+12
| | | | (#8775)
* Add support for hardware and board initialisation overrides. (#8330)Nick Brassel2020-04-132-0/+57
| | | | | | | | | | | | | | | | | | | | | | | | | * Add support for hardware and board initialisation overrides. * qmk cformat. * Add some documentation. * Docs clarity. * Make early_hardware_init_pre a no-op for now, until migrations occur. * Doco update * Make distinction between keyboard and ChibiOS board in docs * Doc anchors. * Update tmk_core/protocol/chibios/main.c Co-Authored-By: Joel Challis <git@zvecr.com> * Rework bootloader entry to be off by default, allow opting-in. Co-authored-by: Joel Challis <git@zvecr.com>
* Add *OPT aliases for *ALT keycodes and macros (#8714)Konstantin Đorđević2020-04-126-17/+17
|
* Fix a couple of typos that were causing confusion (#8767)Joshua Moses Diamond2020-04-121-2/+2
|
* quantum/debounce: Added sym_pk debounce algorithm (#8587)Purdea Andrei2020-04-111-0/+1
| | | | | | | | | | | | | | | | | | | | * quantum/debounce: Added sym_pk debounce algorithm * Apply suggestions from code review Co-Authored-By: Ryan <fauxpark@gmail.com> * quantum/debounce/sym_pk: delete comments and rename functions following code review * quantum/debounce/sym_pk: Modifications for code readability according to code review * quantum/debounce/sym_pk: Modifications for code readability according to code review (2) * quantum/debounce/sym_pk: code review: cleaner code Co-Authored-By: Nick Brassel <nick@tzarc.org> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Nick Brassel <nick@tzarc.org>
* Add PS2_MOUSE_ROTATE to compensate for device orientation (#8650)Manna Harbour2020-04-091-0/+19
| | | | | | | | * Add PS2_MOUSE_ROTATE to compensate for device orientation * fixup! Add PS2_MOUSE_ROTATE to compensate for device orientation * Reformat with IndentPPDirectives: AfterHash as per #6316
* Fix compile issues related to NO_ACTION_MACRO/FUNCTION and LTO_ENABLE (#8663)Konstantin Đorđević2020-04-091-5/+5
| | | | | | | | | | | | | | | | * Define NO_ACTION_MACRO/FUNCTION in header instead of makefile when LTO is enabled Currently, boards and keymaps that define NO_ACTION_MACRO/FUNCTION unconditionally will not compile with LTO_ENABLE (#8604). This fixes the issue by moving the definitions from common.mk to action.h, which enables us to check for previous definitions of those macros (this cannot be done in a makefile). * Remove LTO checks in templates Since now NO_ACTION_MACRO/FUNCTION are defined as needed in action.h (which is included by quantum.h), checking for LTO in keyboard and user code is no longer required. * Update LTO_ENABLE docs
* Make dedicated sections for user/dev commands in docsErovia2020-04-081-70/+65
|
* Rebase on master, hide some other subcommandsErovia2020-04-083-251/+21
| | | | | | | | | | | The list of hidden subcommands were approved by @skullydazed ;) Currently hidden if 'user.developer' is not True: - cformat - docs - kle2json - pyformat - pytest
* CLI: Add development mode supportErovia2020-04-082-0/+252
| | | | | Hide development specific options and don't require dev modules unless `user.developer` is set to `True`.
* spi_master for AVR (#8299)Ryan2020-04-0810-1/+138
| | | | | | | | | | | | | | | | | | | | | | | | | | | * Change _delay_ms/us() to wait_ms/us() * Switch to platform-agnostic GPIO macros * Add AVR spi_master and migrate Adafruit BLE code * Set verbose back to false * Add clock divisor, bit order and SPI mode configuration for init * Add start and stop functions * Move configuration of mode, endianness and speed to `spi_start()` * Some breaks here would be good * Default Adafruit BLE clock divisor to 4 (2MHz on the Feather 32U4) * Remove mode and divisor enums * Add some docs * No hr at EOF * Add links in sidebar
* Update C coding conventions to match .clang-format config for i… (#8717)Konstantin Đorđević2020-04-071-5/+5
| | | | | * Update C coding conventions to match current .clang-format config for indenting PP directives * Make indenting guideline clearer
* add japanese translation (feature part 01) (#8196)umi2020-04-026-0/+1024
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * add feature part 01 * update sentences * update sentences * update sentences * update file based on comment * leave ctrl, shift, alt key name as alphabet * update file based on comment * update file based on comment * update file based on comment * update file based on comment * remove unnecessary space on define line * update sentence based on pull request's comment * translate 'breathing' in document * change expression in table * update file based on comment * change the word 'brightness', and update based on comment * update based on comment * update based on comment * add language directory name to each internal link * update based on comment * update based on comment
* [Docs] Update Japanese translation of i2c_driver.md (#8523)shela2020-04-011-24/+34
| | | | | * Update Japanese translation of i2c_driver.md * Apply a part of suggestions from code review
* [Docs] Japanese translation of hardware_*.md (#8278)Takuya Urakawa2020-04-013-0/+389
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * add docs/ja/hardware.md * add docs/ja/hardware_avr.md * add docs/ja/hardware_drivers.md * add docs/ja/hardware_keyboard_guidelines.md * update hardware.md * add space around alphabet word * fix link tag * Apply suggestions from code review Co-Authored-By: shela <shelaf@users.noreply.github.com> * remove ja/hardware.md * Apply suggestions from code review Co-Authored-By: shela <shelaf@users.noreply.github.com> Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * match word matrix with other translations * Apply suggestions from code review 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>
* Update newbs_getting_started.mdBram de Wilde2020-03-311-1/+1
| | | qmk is not available in the official Arch repositories. It is in the AUR, this install command will work if user has `yay` installed.
* Rename UC_OSX (and related constants) to UC_MAC (#8589)Konstantin Đorđević2020-03-312-8/+10
| | | | | | | | | | | | | | | | | | | | | * Rename UC_OSX (and related constants) to UC_MAC * Update UNICODE_SONG_OSX references to UNICODE_SONG_MAC * Update UC_M_OS references to UC_M_MA * Add UC_OSX alias for backwards compatibility * Add deprecation warning for UC_OSX to Unicode docs * Add UC_M_OS alias for backwards compatibility * Update newly found UC_M_OS and UNICODE_SONG_OSX references * Add legacy UNICODE_MODE_OSX alias, revert changes to user keymaps * Add legacy UNICODE_SONG_OSX alias, revert changes to user keymaps * Replace removed sounds in Unicode song doc examples
* Add Japanese translation of cli_commands.md (#8513)shela2020-03-311-0/+258
|
* [Docs] Update Japanese translation of cli.md (#8510)shela2020-03-311-263/+9
| | | | | | | | | * Update Japanese translation of cli.md * Update docs/ja/cli.md Co-Authored-By: s-show <s1shimz@gmail.com> Co-authored-by: s-show <s1shimz@gmail.com>
* [Docs] Update Japanese translation of faq related documents (#8521)shela2020-03-313-16/+54
| | | | | | | | | * Update Japanese translation of faq related documents * Update docs/ja/faq_general.md Co-Authored-By: s-show <s1shimz@gmail.com> Co-authored-by: s-show <s1shimz@gmail.com>
* Update Japanese translation of config_options.mdshela2020-03-311-134/+140
|
* Update Japanese translation with prefix 'getting'shela2020-03-314-170/+4
|
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-17 22:07:48 +0000