summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2019-02-15Add support for using ranges for RGB (#4981)Erovia1-31/+37
* Add support for using ranges for RGB This patch adds support for controlling continuous ranges of RGB LEDs. Helper functions for split boards are also available. * RGB Range: Use hardware-platform agnostic wait
2019-02-15Update KC_GESC documentation (#5053)Yan-Fa Li1-1/+9
* Update KC_GESC documentation - document caveats on OSX and expected behavior with KC_GESC and GUI - clarify documentation slightly - give examples of expected output in actual use * Update OSX -> macOS * Captilization * remove simply
2019-02-15docker_build.sh: Run container in interactive mode (#5088)Konstantin Đorđević1-4/+4
* docker_build.sh: Run container in interactive mode * Add message about QMK Toolbox * Update Docker docs
2019-02-15Improve Encoder documentation (#5130)Ben1-1/+1
2019-02-15Debounce refactor / API (#3720)Drashna Jaelre1-0/+46
* Added xeal60 via clone of lets split * Delete removed other keymaps * Basic keymap (no FN). Compiles. * Removed NP_STAR and NP_SLSH. * Removed "debounce_algo = manual" in all keyboards with CUSTOM_MATRIX = yes. * Changed order of rules in TMK. Documented feature. * Fixed missing whitespace in debounce documentation Table wasn't working due to missing newline. * Added bold in a few areas. * DO NOT USE - Removed debounce from TMK. * Remove accidental xeal60 commit * DO NOT USE - debounce successfully compiled. * DO NOT USE Revert back to original API to support split_keyboards. * Working eager_pk * Whitespace cleanup. * Restored debounce.h since there wasnt any real change. * Moved debouncing_time variable to inside #if debounce * Removed check for custom_matrix. We can safely include the debounce file for compilation when custom_matrix is used. * Removed #include "matrix.h" from debounce.h * Bug fix - was using MATRIX_ROWS instead of num_rows * Fixed compilation error with debounce_sym_g * Renamed DEBOUNCE_ALGO to DEBOUNCE_TYPE * Malloc array in debounce_eager_pk, since split keyboards only use MATRIX_ROWS/2. * Fix compile error in debounce_eager_pk * Stricter, leaner DEBOUNCE_TYPE section in common_features.mk. Cleanup debounce_type.mk
2019-02-15Add kb and user level keyboard initialization functions (#3113)Drashna Jaelre1-8/+60
* Add suspend functions * Disable RGB code if it's disabled * Add keyboard_init functions * Change where references so it will compile * Wrong command chained in wake up kb function * Fix non-feature file changes * Add documentation * Re-add matrix init docs * add rgblight code to example * Remove suspend code * Clean up docs * Fix docs * Fix suspend code * more doc fixes * change function to startup_* rather than keyboard_init_ * fix spelling error * fix up docs to finish removing keyboard_init * Use Pre and Post init functions * Update Documenation * Remove changes to my keymap and userspace code * Cleanup * Revert changes to extra files * Forgot a semicolon * Make sure all protocols call keyboard_setup * Cleanup functions * Unset startup_user * Remove changes from division keyboard * Readd startup_user function * Remove all to startup_user * Update docs/custom_quantum_functions.md Co-Authored-By: drashna <drashna@live.com> * Update docs/custom_quantum_functions.md Co-Authored-By: drashna <drashna@live.com> * Add suggestion line * Rebase fixes * Update documentation to be more useful/accurate * Cleanup of documentation * Fix spacing inconsistency * Revert unexpected change to keymap
2019-02-15Add a mechanism for force building a particular community layout (#5027)zvecr1-0/+29
* Add a mechanism for force building a particular community layout * Add docs for FORCE_LAYOUT argument * Update output name when FORCE_LAYOUT is enabled
2019-02-11Add documentation for led matrixskullY3-170/+51
2019-02-11The beginning of a simple led matrix driver for is31fl3731skullY1-0/+217
2019-02-09added missing ; on example (#5089)Joshua Bragge1-1/+1
2019-02-09Add label to the info.json referenceskullY1-0/+3
2019-02-09fix the case for some elementsskullY1-8/+8
2019-02-09Update docs/reference_info_json.mdnoroadsleft1-1/+1
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
2019-02-09Clarify LAYOUT vs LAYOUT_allskullY1-3/+5
2019-02-09Address comments in #4832. Move info.json reference to its own file.skullY3-81/+87
2019-02-09Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević1-1/+1
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
2019-02-09Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević1-1/+1
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
2019-02-09Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević1-1/+1
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
2019-02-09Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević1-1/+1
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
2019-02-09Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević1-1/+1
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
2019-02-09Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević1-1/+1
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
2019-02-09Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević1-1/+1
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
2019-02-09Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević1-1/+1
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
2019-02-09Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević1-1/+1
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
2019-02-09Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević1-1/+1
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
2019-02-09Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević1-1/+1
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
2019-02-09Update docs/hardware_keyboard_guidelines.mdfauxpark1-1/+1
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
2019-02-09tweak the keyboard guidelinesskullY1-4/+6
2019-02-09Update the keyboard guidelinesskullY1-3/+77
2019-02-07Adds a period to the docs.Erez Zukerman1-1/+1
Yes, really. Revolutionary, I know!
2019-02-07[Docs] Bootmagic Lite Caveat (#5069)Yan-Fa Li1-1/+3
Document that using bootmagic lite resets the eeprom every time.
2019-02-06faq_build.md: Add section about serial devices on LinuxRobin Hallabro-Kokko1-0/+4
2019-02-05Improvements to Space Cadet Shift (#3856)Anthony1-6/+10
* Improvement of Space Cadet Shift by preventing to automatically apply a modifier on the key and allow to override the default modifier. Closes qmk/qmk_firmware#3815 * Improve the use of the DISABLE_SPACE_CADET_MODIFIER flag to avoid unregistering KC_LSFT when equals to LSPO_MOD * change #if to if statement
2019-02-05Add One Shot Key callbacks (#4697)Thomas Baart1-0/+75
* Added callbacks to one shot modifier changes * Altered signature of callback functions * Reordered the callback methods, shortened brief documentation * Added One Shot Modifier callback documentation * First attempt at unit tests * Revert "First attempt at unit tests" This reverts commit 5ec21a782202c0d74cf21cb852bd319f0c8b4842. * Simplified oneshot function implementations * Made clear_oneshot_locked_mods to be conform action_util.h, adhering to the (void) signature * Made used datatypes for oneshot mods consistently unsigned integers * Corrected callback to call clear callback when clear_oneshot_locked_mods is invoked * Simplified oneshot equals statements * Corrected return type and signature of get and set oneshot locked mods * Consolidated one shot callbacks, added initial layer callback version * Fixed non-updating one shot layer variable after timeout or other clear, added code comments * Added better one shot key docs
2019-01-29Contribute the MechMerlin QMK Configurator docs (#4986)MechMerlin3-3/+112
* first pass at configurator docs * edit existing docs to make reference to QMK Configurator * contribute my own newb guide to QMK officially from https://github.com/mechmerlin/qmk_setup/blob/master/qmk_configurator.md * Update docs/newbs_building_firmware_configurator.md Co-Authored-By: mechmerlin <30334081+mechmerlin@users.noreply.github.com> * Update docs/newbs_building_firmware_configurator.md Big red box! Co-Authored-By: mechmerlin <30334081+mechmerlin@users.noreply.github.com> * Update docs/newbs_building_firmware_configurator.md Big red box Co-Authored-By: mechmerlin <30334081+mechmerlin@users.noreply.github.com> * Update docs/newbs_building_firmware_configurator.md Co-Authored-By: mechmerlin <30334081+mechmerlin@users.noreply.github.com> * Update docs/newbs_building_firmware_configurator.md Co-Authored-By: mechmerlin <30334081+mechmerlin@users.noreply.github.com> * Update docs/newbs_building_firmware_configurator.md Co-Authored-By: mechmerlin <30334081+mechmerlin@users.noreply.github.com> * Update docs/newbs_building_firmware_configurator.md Co-Authored-By: mechmerlin <30334081+mechmerlin@users.noreply.github.com>
2019-01-29Backlight - New option : BACKLIGHT_CAPS_LOCK (#4769)Rockman181-0/+1
* [BACKLIGHT_CAPS_LOCK_INDICATOR] Use backlight toggling as Caps Lock LED I've implemented this feature because S65-X doesn't have LED indicators and the existing led_set_kb(usb_led) function try to use backlight as indicator but that creates an inconsistency with backlight_config state. - define `BACKLIGHT_CAPS_LOCK_INDICATOR` to enable Caps Lock indicator using backlight (for keyboards without dedicated LED) - Don't turn off LED indicators when suspend because backlight is already turned off. Else led_set(0) will turn back on backlight. - Documentation has been updated * [BACKLIGHT_CAPS_LOCK_INDICATOR] Turn off all LED indicators except Caps Lock if BACKLIGHT_CAPS_LOCK_INDICATOR * [BACKLIGHT_CAPS_LOCK] Rename BACKLIGHT_CAPS_LOCK_INDICATOR * [BACKLIGHT_CAPS_LOCK] Use new IS_LED_ON method
2019-01-27Fix Command feature: use get_mods() instead of keyboard_report->mods (#4955)Konstantin Đorđević2-33/+33
* Remove unnecessary IS_COMMAND definition in clueboard/66/rev4 * Replace keyboard_report->mods with get_mods() in IS_COMMAND definitions * Update docs to use get_mods() instead of keyboard_report->mods * Replace keyboard_report->mods with get_mods() in tmk_core/protocol/usb_hid/test For some reason, this occurrence used KB_LSHIFT and KB_RSHIFT, which don't exist * Replace keyboard_report->mods with get_mods() in Massdrop keyboards (as per @patrickmt)
2019-01-26Stricter, leaner DEBOUNCE_TYPE section in common_features.mk. Cleanup ↵alex-ong1-10/+12
debounce_type.mk
2019-01-26Removed check for custom_matrix. We can safely include the debounce file for ↵alex-ong1-12/+6
compilation when custom_matrix is used.
2019-01-26Whitespace cleanup.alex-ong1-10/+7
2019-01-26DO NOT USE Merge branch 'master' into debounce_refactorAlex Ong18-511/+488
Merged, however now there are two debounce.h and debounce.c to mess around with and coalesce. # Conflicts: # quantum/matrix.c
2019-01-25Add C(), A() and G() to match already existing S() (#4673)fauxpark2-46/+46
2019-01-25Adding documentation for the LM layer modifier. (#3617)Dave Brown1-1/+1
* Adding documentation for the LM layer modifier. This will hopefully clear up some of the confusion around adding this layer modifier. I struggled with this a bit as well at first. * Removing duplicate table. * Changed section title to `Changing Layers` * Retain name
2019-01-25Fix a typo in link to the Pro Micro ISP firmwareBalz Guenat1-1/+1
2019-01-21Tidy up IS_{,HOST_}LED_{ON,OFF} macros (#4894)Konstantin Đorđević1-18/+9
* Tidy up IS_{,HOST_}LED_{ON,OFF} macros * Tweak LED control docs
2019-01-18Fix Encoder documentation (#4861)Drashna Jaelre2-8/+13
2019-01-18Grammatical fixes for GPIO Control doc (#4869)noroadsleft1-3/+3
* Grammatical fixes for GPIO Control doc I found the Advanced Settings section to be poorly written. * Commit suggestions from fauxpark * Change first instance of "microcontroller" to match suggestion
2019-01-18Add new brightness aliases to keycodes_basic.mdfauxpark2-253/+249
2019-01-18Defined IS_(HOST_)LED_ON/OFF() and improved LED documentation (#4853)DidierLoiseau1-8/+46
* Defined IS_(HOST_)LED_ON/OFF() and improved LED documentation * Update docs/custom_quantum_functions.md Co-Authored-By: DidierLoiseau <didierloiseau+github@gmail.com> * Update docs/custom_quantum_functions.md Co-Authored-By: DidierLoiseau <didierloiseau+github@gmail.com> * Integrated @drashna and @fauxpark's PR comments - changed all plurals of "LED" to "LEDs" in the file - rewording of the note about host_keyboard_leds() vs. led_set_user() * Update docs/custom_quantum_functions.md Co-Authored-By: DidierLoiseau <didierloiseau+github@gmail.com>
2019-01-18MacOS Brightness Alias (#4836)Jeremy Bernhardt1-4/+4
* Added aliases for OSX brightness * Updated docs for alises * Moved aliases, added docs to Brightness section * Update docs/keycodes.md Co-Authored-By: germ <jeremythegeek@gmail.com> * Update docs/keycodes.md Co-Authored-By: germ <jeremythegeek@gmail.com> * Update keycode.h * Update keycode.h * Update keycodes.md * Update docs/keycodes.md Co-Authored-By: germ <jeremythegeek@gmail.com>
generated by cgit v1.2.3-24-g4f1b (git 2.32.0) at 2024-06-16 02:20:18 +0200