summaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
...
* Minor updates to build tools docs revised (#4195)Dylan Khor2018-10-221-3/+3
| | | | | | * add initial khord iris keymap * correct path of windows qmk install script
* Updates docs - planck 6 and macos instructions (#4201)Colin T.A. Gray2018-10-222-0/+3
| | | | | | * add note about how to install rev6 (dfu-util) * include instructions on installing dfu-util on macOS
* Add instructions for zadig when bootloader device is unknownDrashna Jaelre2018-10-201-1/+9
|
* Some cleanup of the Useful Functions docs (#4064)Drashna Jaelre2018-10-191-14/+64
| | | | | | * Add examples for tri layers * Clean up and spelling fixes
* Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning ↵noroadsleft2018-10-185-2/+171
| | | | | | | | | | | | | | | | | | | | | | Resources doc (#3902) * Docs: newbs_learn_more_resources.md: formatting * Added QMK Git Conventions doc, initial version * Renamed contributing_qmk.md to newbs_best_practices.md * Updated per review by @drashna * Added navigation links * Updated to Best Practices doc * Minor updates to Learn More Resources doc Markdown formatting consistency because I'm particular about it. * Added Merge Conflict section to Best Practices doc
* Fix more broken links to the HID specChristoffer Holmberg2018-10-172-2/+2
|
* Fix grammar, typos, and the link to HID specificationChristoffer Holmberg2018-10-171-7/+7
|
* Fix doc typoJim Tittsler2018-10-151-1/+1
|
* Fix Typo in Custom Quantum functions document (led_state) (#4129)asakuno2018-10-131-2/+2
| | | | | *_LOCK   ↓ DEL
* add a notice into docs/feature_rgblight.mdmtei2018-10-111-1/+2
|
* Add documentation for Combo featureDrashna Jaelre2018-10-104-0/+96
|
* Cleanup learning newb linksDrashna Jaelre2018-10-103-8/+8
|
* Update and cleanup AVR Hardware docsDrashna Jaelre2018-10-101-22/+20
|
* Specify max layers supported in layer keycodesDrashna Jaelre2018-10-101-2/+2
|
* Fix formatting in Unicode textDrashna Jaelre2018-10-091-5/+5
|
* Added link to One Shot KeysBrian Choromanski2018-10-091-1/+1
|
* Added OSL to list of layer togglesBrian Choromanski2018-10-091-0/+1
|
* Update Bluetooth docs (#4062)chipperdoodles2018-10-072-2/+34
| | | | | | | | | | | | | | | | | | * syncing upstream * Bluetooth Doc update More Description in bluetooth section, Addition to Config options rules.mk section. * merge upstream chibios * lib/chibios checkout * Additional EZ key Section added back EZ-Key diy link, Cleaned up some errors
* Update and clarify Unicode documentation (#4065)Drashna Jaelre2018-10-061-18/+89
| | | | | | | | | | | | | | * Update and clarify Unicode documentation * Fixed UCIS info based on feedback from algernon * Further clarifications and cleanup * Formatting * Add an example for unicode map * fix AutoHotKey title
* Update Contrib doc (#4068)Drashna Jaelre2018-10-061-2/+21
| | | | | | | | | | | | | | * Add link for style * ignore java * Add example and update link? * Minor fixes * Change 1TBS text * comments
* ARM SWD guideyiancar2018-10-053-0/+89
| | | | | - Added a detailed (but saddly long) debugging guide. - Modified sidebar and summary to include the links.
* Add C hint to inline codeYan-Fa Li2018-10-011-19/+19
|
* Add send_unicode_hex_string function (#3828)Drashna Jaelre2018-10-011-1/+6
| | | | | | | | | | | * Add send_string_unicode function Co-authored-by: kdb424 <kdb424@gmail.com> Co-authored-by: Konstantin <vomindoraan@gmail.com> * Clean up code based on feedback * Fix includes
* Add tap_code function (#3784)Drashna Jaelre2018-10-011-0/+4
| | | | | | | | | | * Add tap_code * formatting * Doc clarification * Rename variable to make more consistent
* Add Function level EECONFIG code for EEPROM (#3084)Drashna Jaelre2018-10-011-0/+140
| | | | | | | | | | | | | | | | | | | | | | | | | | | | * Add Function level EEPROM configuration Add kb and user functions for EEPROM, and example of how to use it. * Bug fixes and demo * Additional cleanup * Add EEPROM reset macro to example * Forgot init function in list * Move eeconfig_init_quantum function to quantum.c and actually set default layer * See if removing weak quantum function fixes issue * Fix travis compile error * Remove ifdef blocks from EECONFIG so settings are always set * Fix for ARM EEPROM updates * Fix merge issues * Fix potential STM32 EEPROM issues
* Make digital rain RGB matrix effect #define configurable.Daniel Shields2018-10-011-0/+1
|
* Correct small typoAnthony Som2018-10-011-1/+1
| | | A small typo (it -> in) that I noticed while reading through the documentation
* Spell-check update for Userspace documentationnoroadsleft2018-09-281-4/+4
| | | | Because leaving review comments on a PR that's already been merged doesn't make any sense.
* Update quantum matrix to support both AVR and Chibios ARM (#3968)yiancar2018-09-281-0/+23
| | | | | | | | | | | | | | | | | | | | | | | | | | | * Update quantum matrix to support both AVR and Chibios ARM - Addition of STM32 pin definitions - Created abstruction layer defines to control GPIO (This is a bit pointless for Chibios as we are creating a PAL ontop of a PAL but it is necessary for uniformity with AVR) - Modified matrix.c to use the above functions * minor ifdef fix * Rename of functions and docs - Added documentation. - Renamed functions according to Jack's spec. * Massdrop fix * Update matrix.c * Update quantum.h * Update quantum.h * Update quantum.h * Update internals_gpio_control.md
* Update to the Userspace documentation (#4005)Drashna Jaelre2018-09-281-45/+133
| | | | | | | | | | | | | | * Overhaul to Userspace Documentation * Formatting issues * Additionaly formatting fixes * Add Readme info * Additionaly Readme info * Formatting fixes
* Update Document Templates to reflect newer wording and URLs (#4006)Drashna Jaelre2018-09-281-1/+1
| | | | | | | | * Add pragma once info to contributing guidelines * Fix links in readme template to match doc site * Revert changes to contributing doc as somebody already changed it
* add 'mavrdude' target into tmk_core/avr.mk (#3986)Takeshi ISHII2018-09-271-0/+6
| | | | | | | | | | | | | | * add 'mavrdude' target into tmk_core/avr.mk I made it a little convenient when writing the same binary to multiple Pro Micro. * rename target name 'mavrdude' to 'avrdude-loop' * modify docs/flashing.md about avrdude-loop * mdify docs/flashing.md again * modifi docs/flashing.md 3rd
* Add On/Off keycodesDrashna Jaelre2018-09-251-5/+7
|
* Store Clicky status in EEPROMDrashna Jaelre2018-09-251-3/+1
|
* Circuitry sample for PS/2 Mouse (#3959)Luca2018-09-231-0/+18
| | | | | | | Added a sample circuitry for handling the connection of a PS/2 Mouse. Even if it's written that a circuitry is needed, there're a lot of other things and the information gets lost really fast. A really simple sample helps to remember who wants to implement the functionality about the circuitry.
* Remove redefinition of `_______` in documentation example (#3924)Anthony Wharton2018-09-191-3/+9
| | | | | | | | * Remove redefinition of `_______` in documentation example * Slight rewording to include purpose of defintions * Update include to newer macro
* Create AG_TOGG code to toggle Alt/Gui swap.Joe Wasson2018-09-172-0/+2
|
* Fix LEADER_KEY docs.dsissitka2018-09-171-1/+1
| | | | | LEADER_KEY needs to be set in config.h, not keymap.c. Credit goes to @randywallace for figuring this one out: https://github.com/qmk/qmk_firmware/issues/2514#issuecomment-384847485
* Make `PREVENT_STUCK_MODIFIERS` the default (#3107)Joe Wasson2018-09-173-3/+11
| | | | | | | | | | * Remove chording as it is not documented, not used, and needs work. * Make Leader Key an optional feature. * Switch from `PREVENT_STUCK_MODIFIERS` to `STRICT_LAYER_RELEASE` * Remove `#define PREVENT_STUCK_MODIFIERS` from keymaps.
* docs/contributing: add `#pragma once` to Coding ConventionsJames Laird-Wah2018-09-151-0/+1
| | | | | | This supersedes the older include guard mechanism since all the compilers now support it. It's easier for new users and less prone to error.
* Add an easy way to create new keymaps for your favorite keyboard (#3868)MechMerlin2018-09-131-0/+14
| | | | | | | | | | | | | | | | | | | | * initial commit of keymap creation script * create default keymap * pass shellcheck * provide a better usage message * change printf string to more accurately reflect the path * make it more easily understood * found another typo * add documentation regarding the new_keymap script * enforce lowercase for userinputs
* rgblight.[ch] more configurable (#3582)Takeshi ISHII2018-09-131-15/+27
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * add temporary test code rgblight-macro-test1.[ch] * rgblight.h : mode auto numberring and auto generate mode name symbol No change in build result. * rgblight.c use RGBLIGHT_MODE_xxx symbols No change in build result. * quantum.c use RGBLIGHT_MODE_xxx symbols No change in build result. * fix build break. when RGB_MATRIX_ENABLE defined * add temporary test code rgblight-macro-test2.[ch] * modify rgblight_mode_eeprom_helper() and rgblight_sethsv_eeprom_helper() * modify rgblight_task() * configurable each effect compile on/off in config.h * update docs/feature_rgblight.md * fix conflict. docs/feature_rgblight.md * remove temporary test code rgblight-macro-test*.[ch] * fix comment typo. * remove old mode number from comment * update docs/feature_rgblight.md about effect mode * Revert "update docs/feature_rgblight.md about effect mode" This reverts commit 43890663fcc9dda1899df7a37d382fc38b1a6d6d. * some change docs/feature_rgblight.md * fix typo * docs/feature_rgblight.md update: revise mode number table
* Add the ability to disable the USB startup check for Chibiosyiancar2018-09-051-0/+4
| | | | | | - Added support for NO_USB_STARTUP_CHECK. This allows the keyboard do function and not get stuck in a SUSPENDED state loop in case of no USB connection. - Added support for WAIT_FOR_USB. In LUFA no keyboard has this flag enable therefor no keyboard waits for usb to be active. - Added documentation for both configuration flags as they were missing.
* Docs: Tabulate Modifier & Mod-Tap keycode listings in advanced keycodes docs ↵fauxpark2018-08-302-49/+69
| | | | (#3799)
* Tweak the wording in "Becoming a QMK Collaborator"fauxpark2018-08-301-4/+6
|
* Docs: add process_terminal() and update links to other functions (#3778)arlenk2018-08-291-24/+29
| | | | | | | | * add process_terminal() and update links to other functions * convert links to permalinks and add a few missing process_* functions * update links in main text as well
* Mask off keycode/layer/mod where possible in LT(), MT(), etc. (#3430)fauxpark2018-08-291-6/+4
| | | | | | | | * Mask off keycode/layer/mod where possible in LT(), MT(), etc. * Don't need these parentheses * Put back parentheses for order of operations
* Docs: Add docs for the `LAYOUT_*` macro to layouts (#3772)Evan Travers2018-08-281-0/+6
| | | | | | | When moving my planck layout to my let's split, I ran into this issue because I had copied my planck layout from the default layout which just used the `{}` array form for the keymap layers. I checked the docs, but this bit wasn't clear to me. I'm sure @ishtob or @drashna helped me on discord, but this seemed to be the logical place to add a helpful hint.
* ISSI31FL3733 driver (#3679)yiancar2018-08-282-3/+55
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * ISSI31FL3733 driver - Addapted IS31 driver for the above driver * fix my branch * ISSI31FL3733 driver - Inclusion of above ISSI led driver * IS31fl3733 driver - Added correct function for control registers * Finalized support for ISSI31fl3733 led driver - Finalized and tested driver. - Modified i2c_master for arm due to declaration mistake. - Fixed spaces/tabs in quantum.h file. - Fixed spaces/tabs in common_features.mk file. - Removed unnecessary includes from rgb_matrix.c file. - Added local definitions for MIN and MAX macros in rgb_matrix.c file. - Adjusted chevron effect. - Added necessary define (RGB_3733_MATRIX_ENABLE) for makefile. - Added necessary C define (ISSI3733) to aid with inclusion of the correct header file. - Added documentation for the new driver. * Driver structure update - Changed rule includes to be more condensed (RGB_MATRIX_ENABLE = IS31FL3731) and (RGB_MATRIX_ENABLE = IS31FL3733) - Updated documentation - Reverted to the use of differently named functions for each driver and selecting the needed ones within rgb_matrix.c * ISSI Drivers refractoring - Moved issi drivers in a dedicated folder - Updated documentation * I2C library fix I released the special pins incorrectly before. It is now fixed.
* Helpful functionsDrashna Jaelre2018-08-264-0/+69
|