summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2019-02-10Add documentation for led matrixskullY
2019-02-10The beginning of a simple led matrix driver for is31fl3731skullY
2019-02-09added missing ; on example (#5089)Joshua Bragge
2019-02-08Add label to the info.json referenceskullY
2019-02-08fix the case for some elementsskullY
2019-02-08Update docs/reference_info_json.mdnoroadsleft
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
2019-02-08Clarify LAYOUT vs LAYOUT_allskullY
2019-02-08Address comments in #4832. Move info.json reference to its own file.skullY
2019-02-08Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
2019-02-08Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
2019-02-08Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
2019-02-08Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
2019-02-08Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
2019-02-08Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
2019-02-08Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
2019-02-08Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
2019-02-08Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
2019-02-08Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
2019-02-08Update docs/hardware_keyboard_guidelines.mdKonstantin Đorđević
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
2019-02-08Update docs/hardware_keyboard_guidelines.mdfauxpark
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
2019-02-08tweak the keyboard guidelinesskullY
2019-02-08Update the keyboard guidelinesskullY
2019-02-07Adds a period to the docs.Erez Zukerman
Yes, really. Revolutionary, I know!
2019-02-06[Docs] Bootmagic Lite Caveat (#5069)Yan-Fa Li
Document that using bootmagic lite resets the eeprom every time.
2019-02-06faq_build.md: Add section about serial devices on LinuxRobin Hallabro-Kokko
2019-02-05Improvements to Space Cadet Shift (#3856)Anthony
* 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 Baart
* 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-28Contribute the MechMerlin QMK Configurator docs (#4986)MechMerlin
* 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-28Backlight - New option : BACKLIGHT_CAPS_LOCK (#4769)Rockman18
* [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ć
* 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-27Stricter, leaner DEBOUNCE_TYPE section in common_features.mk. Cleanup ↵alex-ong
debounce_type.mk
2019-01-26Removed check for custom_matrix. We can safely include the debounce file for ↵alex-ong
compilation when custom_matrix is used.
2019-01-26Whitespace cleanup.alex-ong
2019-01-26DO NOT USE Merge branch 'master' into debounce_refactorAlex Ong
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)fauxpark
2019-01-25Adding documentation for the LM layer modifier. (#3617)Dave Brown
* 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-24Fix a typo in link to the Pro Micro ISP firmwareBalz Guenat
2019-01-20Tidy up IS_{,HOST_}LED_{ON,OFF} macros (#4894)Konstantin Đorđević
* Tidy up IS_{,HOST_}LED_{ON,OFF} macros * Tweak LED control docs
2019-01-18Fix Encoder documentation (#4861)Drashna Jaelre
2019-01-17Grammatical fixes for GPIO Control doc (#4869)noroadsleft
* 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-17Add new brightness aliases to keycodes_basic.mdfauxpark
2019-01-17Defined IS_(HOST_)LED_ON/OFF() and improved LED documentation (#4853)DidierLoiseau
* 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-17MacOS Brightness Alias (#4836)Jeremy Bernhardt
* 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>
2019-01-17Simplify split_common Code significantly (#4772)James Churchill
* Eliminate separate slave loop Both master and slave run the standard keyboard_task main loop now. * Refactor i2c/serial specific code Simplify some of the preprocessor mess by using common function names. * Fix missing #endif * Move direct pin mapping support from miniaxe to split_common For boards with more pins than sense--sorry, switches. * Reordering and reformatting only * Don't run matrix_scan_quantum on slave side * Clean up the offset/slaveOffset calculations * Cut undebounced matrix size in half * Refactor debouncing * Minor fixups * Split split_common transport and debounce code into their own files Can now be replaced with custom versions per keyboard using CUSTOM_TRANSPORT = yes and CUSTOM_DEBOUNCE = yes * Refactor debounce for non-split keyboards too * Update handwired/xealous to build using new split_common * Fix debounce breaking basic test * Dodgy method to allow a split kb to only include one of i2c/serial SPLIT_TRANSPORT = serial or SPLIT_TRANSPORT = i2c will include only that driver code in the binary. SPLIT_TRANSPORT = custom (or anything else) will include neither, the keyboard must supply it's own code if SPLIT_TRANSPORT is not defined then the original behaviour (include both avr i2c and serial code) is maintained. This could be better but it would require explicitly updating all the existing split keyboards. * Enable LTO to get lets_split/sockets under the line * Add docs for SPLIT_TRANSPORT, CUSTOM_MATRIX, CUSTOM_DEBOUNCE * Remove avr-specific sei() from split matrix_setup Not needed now that slave doesn't have a separate main loop. Both sides (on avr) call sei() in lufa's main() after exiting keyboard_setup(). * Fix QUANTUM_LIB_SRC references and simplify SPLIT_TRANSPORT. * Add comments and fix formatting.
2019-01-14Pointed LM Docs at expected keycodes (#4835)Jeremy Bernhardt
* Pointed LM Docs at expected keycodes * Update docs/feature_advanced_keycodes.md Co-Authored-By: germ <jeremythegeek@gmail.com>
2019-01-10Documentation clarification (#3611)orbitingorca
* Documentation fix * Further clarification
2019-01-10docs: Add Manjaro/Arch dependencies on getting started page (#2701)Guilherme Lima
* Update getting_started_build_tools.md * Update getting_started_build_tools.md
2019-01-10Adds Proton C Conversion (#4661)Jack Humbert
* adds proton c base * fixes custom matrix include * adds readme.md * initial proton coversion, no pin mapping * start of mcu selection * add pin mapping and sweet16 test * add at90 to list * disable backlight, fix d7 * update flag names * doc updates * proton c update for mcu selection
2019-01-08Tidy up Mod-Tap shortcuts (#4806)fauxpark
2019-01-07Improve consistency in UNICODEMAP code and docs, update ↵Konstantin Đorđević
docs/understanding_qmk (#4774) * Remove unused UNICODE(n) macro, update docs * Add note about max length of unicode_map to docs * QK_UNICODE_MAP → QK_UNICODEMAP * Refactor process_unicode_map * process_unicode_map → process_unicodemap This is done for consistency: UNICODEMAP is the method (hence UNICODEMAP_ENABLE, process_unicodemap), whereas unicode_map is the mapping table itself. * Update references and ordering in docs/understanding_qmk * Add additional note to docs/understanding_qmk * &unicode_map[index] → unicode_map + index This avoids the issue of the compiler sometimes complaining about the array index being out of range * Update docs/getting_started_make_guide * Update method sections in docs/feature_unicode