summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2019-03-05Add more "decent" text editors (#5308)Mitchel van Eijgen1-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.
2019-03-05[Docs] Fix function signature (layer_state_set_*) (#5313)lf1-1/+1
`void uint32_t` is not a return type.
2019-03-04Clean up debounce a bit (#5255)James Churchill3-23/+16
2019-03-04Add LED Matrix to Features list for easy reference (#5280)Drashna Jaelre2-0/+2
2019-02-28[Docs] Add note about using Unicode Hex Input (#5248)Graham P Heath1-2/+4
* Add note about using Unicode Hex Input * Update docs * remove extra return, oops
2019-02-26Ask for your name when generating a new keyboard (#5214)fauxpark1-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>
2019-02-22Replace instances of KEYMAP with LAYOUTnoroadsleft7-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.
2019-02-21Grammar cleanup of Flashing Your Keyboard Newbs Guide (#5201)noroadsleft1-3/+3
Fixed references to a "built" (sic) command, and an incorrect word.
2019-02-21Velocikey: Match RGB animation speed to typing speed (#3754)Chris Lewis2-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
2019-02-21Updated hand wiring docs (#5198)Johannes Jansson1-7/+14
* renamed KEYMAP to LAYOUT in hand wiring docs * added two additional guides for hand wiring
2019-02-20Markdown cleanup on Config Options docnoroadsleft1-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.
2019-02-20[Docs] Fix typo in RGB Matrix Driver configuration (#5182)Ben1-3/+3
* Fix #3797 firmware not compiling If DRIVER_COUNT 1 firmware will not compile. * Fix typo
2019-02-18[Docs] Add section about EEPROM on ARM (#5070)Yan-Fa Li1-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>
2019-02-18Remove CUSTOM_MATRIX option from diode direction (#5090)zvecr1-1/+1
* Remove CUSTOM_MATRIX refs from DIODE_DIRECTION * Remove '#define DIODE_DIRECTION CUSTOM_MATRIX' * Remove CUSTOM_MATRIX refs from DIODE_DIRECTION documentation
2019-02-18Change Command keycode defaults to match corresponding Bootmagic codes (#5078)Konstantin Đorđević1-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
2019-02-17Add clang-format section to contributing.mdJames Churchill1-0/+12
2019-02-17Add docs on using keyboard_post_init_user to enable debug modeszvecr1-1/+11
2019-02-17Haptic feedback generalized - DRV2605 and solenoids (#4939)ishtob1-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
2019-02-15Fix documentation about one shot tap toggleJayesh Vora1-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.
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.