summaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* New RGB Matrix effect: Single color reactive (#5330)M-AS2019-03-171-0/+2
| | | | | | | | * Adds new RGB Matrix effect: rgb_matrix_config'd reactive LEDs * [Docs] Adds disable for new effect * [Docs] Added new effect to list of effects
* [Docs] Add VSCode guide to docs (#5124)Drashna Jaelre2019-03-153-1/+119
| | | | | | | | | | | | | | | | | | | | | | | | | | * Add VSCode guide to docs * Fix settings menu enumeration * Update docs/other_vscode.md Co-Authored-By: drashna <drashna@live.com> * Update docs/other_vscode.md Co-Authored-By: drashna <drashna@live.com> * Update docs/other_vscode.md Co-Authored-By: drashna <drashna@live.com> * Update docs/other_vscode.md Co-Authored-By: drashna <drashna@live.com> * Update docs/other_vscode.md Co-Authored-By: drashna <drashna@live.com>
* Add avrdude split EE_HANDS flash commands (#5414)Danny2019-03-151-0/+4
| | | | | | * Add EEPROM avrdude flashing commands for setting handedness * Update docs with info on flashing EEPROM handedness files with commands
* Fix ascii art (#5407)Brendan Wrafter2019-03-141-1/+1
|
* Next set of split_common changes (#4974)James Churchill2019-03-121-1/+1
| | | | | | | | | | | | | | | | * Update split_common to use standard i2c drivers * Eliminate RGB_DIRTY/BACKLIT_DIRTY * Fix avr i2c_master error handling * Fix i2c_slave addressing * Remove unneeded timeout on i2c_stop() * Fix RGB I2C transfers * Remove incorrect comment
* getting_started_build_tools: dfu-{util,programmer} now available from arch repoenkore2019-03-081-3/+1
| | | See https://www.archlinux.org/packages/extra/x86_64/dfu-programmer/
* [Docs] Update the KC_MAKE example in Userspace docs (#5337)Drashna Jaelre2019-03-081-15/+39
| | | This includes a much more feature rich version of the code, as well as updating for changes that have occurred in QMK Firmware
* [Docs] Add Tap Dance example to the docs (#5326)Dusty Pomerleau2019-03-073-1/+98
| | | | | | | | * add a tapdance example for creating advanced mod-tap and layer-tap keys * add optional curly braces to match QMK conventions * change example to use `register_code16()` and tapdance keycodes more closely matching QMK variants
* Add more "decent" text editors (#5308)Mitchel van Eijgen2019-03-051-1/+1
| | | I'm a web designer and know there are several "decent" code editors out there, but I would figure not everyone into keyboards is, so I found Sublime text a bit of a hard sell for someone who just need to manipulate some text files. VS Code or Atom would b a much better suit for them instead of dropping $80 on a "decent" text editor.
* [Docs] Fix function signature (layer_state_set_*) (#5313)lf2019-03-041-1/+1
| | | `void uint32_t` is not a return type.
* Clean up debounce a bit (#5255)James Churchill2019-03-043-23/+16
|
* Add LED Matrix to Features list for easy reference (#5280)Drashna Jaelre2019-03-032-0/+2
|
* [Docs] Add note about using Unicode Hex Input (#5248)Graham P Heath2019-02-281-2/+4
| | | | | | | | * Add note about using Unicode Hex Input * Update docs * remove extra return, oops
* Ask for your name when generating a new keyboard (#5214)fauxpark2019-02-261-2/+2
| | | | | | | | | | * Ask for your name when generating a new keyboard * Update docs * Apply suggestions from code review Co-Authored-By: fauxpark <fauxpark@gmail.com>
* Replace instances of KEYMAP with LAYOUTnoroadsleft2019-02-217-19/+19
| | | | | | Many instances in the QMK Docs referenced KEYMAP macros, which is outdated terminology. Replaced most instances of KEYMAP with LAYOUT, to reflect the desired usage.
* Grammar cleanup of Flashing Your Keyboard Newbs Guide (#5201)noroadsleft2019-02-211-3/+3
| | | Fixed references to a "built" (sic) command, and an incorrect word.
* Velocikey: Match RGB animation speed to typing speed (#3754)Chris Lewis2019-02-212-0/+31
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Draft commit of typing speed RGB control * More information in the readme * Support all RGB animation modes (Fixes #1) * Added support for all RGB light modes to use typing speed Except christmas lights because that is seizure-inducing at high speeds! * Introduced a value range specific to each RGB mode Because some modes are a little too much when running at full speed! * Update readme.md * Update readme.md * Re-arrange typing_speed definitions (Fixes #5) (#6) * Re-arrange variable definitions to avoid including quantum.h from rgblight.c * Fix a compilation error when trying to run make test:all * Tweaks to the typing speed decay rate * Renamed to momentum; moved implementation into dedicated files * Groundwork for toggling momentum on/off (currently always on) * Add EEPROM toggle for momentum-matching * Moved momentum out of RGBLIGHT_ENABLE toggles so it's more generic * Move momentum decay task out of rgblight_task() * Fix missing momentum.h in lufa.c * Experimental LED support (untested) * Draft commit of typing speed RGB control * More information in the readme * Support all RGB animation modes (Fixes #1) * Added support for all RGB light modes to use typing speed Except christmas lights because that is seizure-inducing at high speeds! * Introduced a value range specific to each RGB mode Because some modes are a little too much when running at full speed! * Update readme.md * Update readme.md * Re-arrange typing_speed definitions (Fixes #5) (#6) * Re-arrange variable definitions to avoid including quantum.h from rgblight.c * Fix a compilation error when trying to run make test:all * Tweaks to the typing speed decay rate * Renamed to momentum; moved implementation into dedicated files * Groundwork for toggling momentum on/off (currently always on) * Add EEPROM toggle for momentum-matching * Moved momentum out of RGBLIGHT_ENABLE toggles so it's more generic * Move momentum decay task out of rgblight_task() * Fix missing momentum.h in lufa.c * Added documentation * Renamed feature to velocikey * Reverted readme to original state * Correct the readme title * Updated feature name in the docs * Update EECONFIG name * Add compile-time toggles for velocikey * Update feature documentation * Revert "Merge branch 'led-support' into master" This reverts commit e123ff5febf61639b9a9020748e1c2e2313460ff, reversing changes made to df111a55b9d4929182e16108b1c0ead15b16df97. * Move velocikey EECONFIG definition to depend on VELOCIKEY_ENABLE * Rename decay_task function to decelerate * Apply suggestions from code review Co-Authored-By: chrislewisdev <chris@chrislewisdev.com> * Re-order eeconfig definitions * Apply coding conventions * Apply #ifdef check in lufa.c * Refactored interval time checks into one functionc * Small rename * Fix unused function error for layouts not using all rgb effects * Only update EEPROM if Velocikey is enabled * Incorporate code review feedback * Small adjustment to top-end decay rate * Add Velocikey documentation to table of contents * Bring tetris:default keymap size down by disabling audio
* Updated hand wiring docs (#5198)Johannes Jansson2019-02-201-7/+14
| | | | | | * renamed KEYMAP to LAYOUT in hand wiring docs * added two additional guides for hand wiring
* Markdown cleanup on Config Options docnoroadsleft2019-02-201-3/+3
| | | | Descriptions for B5_AUDIO, B6_AUDIO, and B7_AUDIO under Hardware Options were partially italicized when parsed by Docsify, though rendered as intended by GitHub.
* [Docs] Fix typo in RGB Matrix Driver configuration (#5182)Ben2019-02-191-3/+3
| | | | | | | | * Fix #3797 firmware not compiling If DRIVER_COUNT 1 firmware will not compile. * Fix typo
* [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