aboutsummaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* [Docs] Add section about EEPROM on ARM (#5070)Yan-Fa Li2019-02-181-6/+14
| | | | | | | | | | | | * [Docs] Add section about EEPROM on ARM * Add Preonic firmware * Update docs/faq_build.md add hyperlink Co-Authored-By: yanfali <yanfali@gmail.com>
* Remove CUSTOM_MATRIX option from diode direction (#5090)zvecr2019-02-181-1/+1
| | | | | | | | * Remove CUSTOM_MATRIX refs from DIODE_DIRECTION * Remove '#define DIODE_DIRECTION CUSTOM_MATRIX' * Remove CUSTOM_MATRIX refs from DIODE_DIRECTION documentation
* Change Command keycode defaults to match corresponding Bootmagic codes (#5078)Konstantin Đorđević2019-02-171-6/+7
| | | | | | | | | | | | | | | | | | * Change Command keycode defaults to match corresponding Bootmagic codes * Make alternate magic key keycodes consistent * Reflect changes from previous commit in tmk_core/common/command.c * Remove unnecessary MAGIC_KEY_* definitions from keymaps compatible with these changes * Swap E and BSPACE for MAGIC_KEY_EEPROM * Add MAGIC_KEY_EEPROM_CLEAR instead of MAGIC_KEY_EEPROM_ALT * Remove BOOTMAGIC_ENABLE checks around EECONFIG stuff * Update Command descriptions
* Add clang-format section to contributing.mdJames Churchill2019-02-171-0/+12
|
* Add docs on using keyboard_post_init_user to enable debug modeszvecr2019-02-161-1/+11
|
* Haptic feedback generalized - DRV2605 and solenoids (#4939)ishtob2019-02-161-0/+147
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * initial work to add eeprom to haptic feedback and decouple the feedback process from keyboards * Haptic feedback enhancements: on/off toggle working, feedback order working todo: -work on modes switching -get modes switching to save to eeprom * haptic enhancement - eeprom and modes added * Added set and get functions for haptic feedback * initial implementation of solenoids under haptic feedback * changed eeprom to 32 bits to reserve blocks for future features * start documentation of haptic feedback * change keycode per comment from reviewers * typo fixes * added eeprom for solenoid configs * added solenoid and docs * Add/fix default parameters configs, improve docs * more doc cleanup * add in solenoid buzz toggle, clean up doc * some fixes for error in compiling solenoid * fix a chibios specific i2c read function and added one for AVR controllers in DRV2605L.c * fixes for avr side issues * update keymap * fix keymap compile error * fix bugs found during solenoid testing * set pin that is not powered during bootloader * added warning about certain pins on the MCU may trip solenoid during DFU/bootloader
* Fix documentation about one shot tap toggleJayesh Vora2019-02-151-1/+1
| | | Based on conversation with Drashna on Discord, we know that if ONE_SHOT_TAP_TOGGLE is 5, then tapping a one shot mod key 5 times holds the one shot key permanently, but to come out of this, you need to press the same key only once.
* Add support for using ranges for RGB (#4981)Erovia2019-02-151-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
* Update KC_GESC documentation (#5053)Yan-Fa Li2019-02-151-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
* docker_build.sh: Run container in interactive mode (#5088)Konstantin Đorđević2019-02-151-4/+4
| | | | | | | | * docker_build.sh: Run container in interactive mode * Add message about QMK Toolbox * Update Docker docs
* Improve Encoder documentation (#5130)Ben2019-02-141-1/+1
|
* Debounce refactor / API (#3720)Drashna Jaelre2019-02-141-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
| * Stricter, leaner DEBOUNCE_TYPE section in common_features.mk. Cleanup ↵alex-ong2019-01-271-10/+12
| | | | | | | | debounce_type.mk
| * Removed check for custom_matrix. We can safely include the debounce file for ↵alex-ong2019-01-261-12/+6
| | | | | | | | compilation when custom_matrix is used.
| * Whitespace cleanup.alex-ong2019-01-261-10/+7
| |
| * DO NOT USE Merge branch 'master' into debounce_refactorAlex Ong2019-01-2618-511/+488
| |\ | | | | | | | | | | | | | | | Merged, however now there are two debounce.h and debounce.c to mess around with and coalesce. # Conflicts: # quantum/matrix.c
| * \ Merge branch 'master' into debounce_refactorAlex Ong2019-01-0455-801/+2376
| |\ \ | | | | | | | | | | | | | | | | # Conflicts: # tmk_core/common/keyboard.c
| * | | Added bold in a few areas.Alex Ong2018-08-291-2/+3
| | | |
| * | | Fixed missing whitespace in debounce documentationAlex Ong2018-08-291-0/+1
| | | | | | | | | | | | Table wasn't working due to missing newline.
| * | | Changed order of rules in TMK. Documented feature.Alex Ong2018-08-291-0/+51
| | | |
* | | | Add kb and user level keyboard initialization functions (#3113)Drashna Jaelre2019-02-141-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
* | | | Add a mechanism for force building a particular community layout (#5027)zvecr2019-02-141-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
* | | | Add documentation for led matrixskullY2019-02-103-170/+51
| | | |
* | | | The beginning of a simple led matrix driver for is31fl3731skullY2019-02-101-0/+217
| | | |
* | | | added missing ; on example (#5089)Joshua Bragge2019-02-091-1/+1
| | | |
* | | | Add label to the info.json referenceskullY2019-02-081-0/+3
| | | |
* | | | fix the case for some elementsskullY2019-02-081-8/+8
| | | |
* | | | Update docs/reference_info_json.mdnoroadsleft2019-02-081-1/+1
| | | | | | | | | | | | Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* | | | Clarify LAYOUT vs LAYOUT_allskullY2019-02-081-3/+5
| | | |
* | | | Address comments in #4832. Move info.json reference to its own file.skullY2019-02-083-81/+87
| | | |
* | | | Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević2019-02-081-1/+1
| | | | | | | | | | | | Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* | | | Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević2019-02-081-1/+1
| | | | | | | | | | | | Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* | | | Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević2019-02-081-1/+1
| | | | | | | | | | | | Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* | | | Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević2019-02-081-1/+1
| | | | | | | | | | | | Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* | | | Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević2019-02-081-1/+1
| | | | | | | | | | | | Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* | | | Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević2019-02-081-1/+1
| | | | | | | | | | | | Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* | | | Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević2019-02-081-1/+1
| | | | | | | | | | | | Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* | | | Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević2019-02-081-1/+1
| | | | | | | | | | | | Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* | | | Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević2019-02-081-1/+1
| | | | | | | | | | | | Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* | | | Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević2019-02-081-1/+1
| | | | | | | | | | | | Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* | | | Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević2019-02-081-1/+1
| | | | | | | | | | | | Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* | | | Update docs/hardware_keyboard_guidelines.mdfauxpark2019-02-081-1/+1
| | | | | | | | | | | | Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* | | | tweak the keyboard guidelinesskullY2019-02-081-4/+6
| | | |
* | | | Update the keyboard guidelinesskullY2019-02-081-3/+77
| | | |
* | | | Adds a period to the docs.Erez Zukerman2019-02-071-1/+1
| | | | | | | | | | | | Yes, really. Revolutionary, I know!
* | | | [Docs] Bootmagic Lite Caveat (#5069)Yan-Fa Li2019-02-061-1/+3
| | | | | | | | | | | | Document that using bootmagic lite resets the eeprom every time.
* | | | faq_build.md: Add section about serial devices on LinuxRobin Hallabro-Kokko2019-02-061-0/+4
| | | |
* | | | Improvements to Space Cadet Shift (#3856)Anthony2019-02-051-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
* | | | Add One Shot Key callbacks (#4697)Thomas Baart2019-02-051-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
* | | | Contribute the MechMerlin QMK Configurator docs (#4986)MechMerlin2019-01-283-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>