summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2018-11-12Make sure that avr-gcc@7 gets linked into the path on MacOS.Michael Kaylan2-1/+2
2018-11-10I2C driver docs (#4298)yiancar3-0/+85
* I2C driver docs - Added I2C driver docs. - Changed arm master i2c driver to have a weak i2c_init as it is impossible to account for all possible port configuration in the STM32 world. * Update docs/i2c_driver.md Co-Authored-By: yiancar <yiangosyiangou@cytanet.com.cy> * Update docs/i2c_driver.md Co-Authored-By: yiancar <yiangosyiangou@cytanet.com.cy> * Update docs/i2c_driver.md Co-Authored-By: yiancar <yiangosyiangou@cytanet.com.cy> * Update docs/i2c_driver.md Co-Authored-By: yiancar <yiangosyiangou@cytanet.com.cy> * GPIO release fix
2018-11-07Configurable Rainbow Swirl range (#4376)Frank Tackitt1-0/+1
* Configurable Rainbow Swirl range This allows tweaking of the rainbow effect to get different effects on keyboards with varied LED layouts. We found the value 1950 works on the RGBKB.net Sol to get a cool striped effect across the keyboard. * Document RGBLIGHT_RAINBOW_SWIRL_RANGE * Better wording for the documentation
2018-11-06Improve wording, punctuation and capitalization in newbs_getting_started ↵Konstantin Đorđević1-40/+38
guide (#4342) * Improve wording, punctuation and capitalization in newbs_getting_started guide Also add some links * Update example build command output Co-Authored-By: vomindoraan <vomindoraan@gmail.com> * Replace occurrences of "layout" with "keymap" Co-Authored-By: MechMerlin <30334081+mechmerlin@users.noreply.github.com> * Explicitly instruct users to open an MSYS2 MinGW 64-bit terminal * MSYS2 Console → MSYS2 MinGW * Replace thin spaces with regular spaces
2018-11-06Update Features page to reflect all of the features linked in the ↵Drashna Jaelre1-0/+4
sidebar/summary
2018-11-06fix example to reflect caveatDrashna Jaelre1-5/+5
2018-11-06Add EEPROM_RESET keycode to core code (#4234)Drashna Jaelre1-12/+13
* Add EEPROM Reset keycode * Add keycode to docs * Move EEPROM Reset code to the end of the enum * Cleanup and naming change
2018-11-06Clarify the Mod Tap defines in documentation (#4352)Drashna Jaelre2-19/+52
* Fix up Mod Tap settings keys * Change link names * permissive hold wordsmith Co-Authored-By: drashna <drashna@live.com> * ignore mod tap wordsmithing Co-Authored-By: drashna <drashna@live.com> * grammar fix Co-Authored-By: drashna <drashna@live.com> * wordsmithing Co-Authored-By: drashna <drashna@live.com> * word smithing Co-Authored-By: drashna <drashna@live.com>
2018-11-06Remove ALTG(kc) as it's misleading and is not actually AltGr (#4338)Konstantin Đorđević2-2/+0
* Remove ALTG(kc) as it's misleading and is not actually AltGr * Add temporary alias for ALGR in keyboards/planck/keymaps/pevecyan/keymap.c
2018-11-03Instructions on how to flash via STM32 bootloader (#4316)Michael Pio1-4/+27
* Add instructions on flashing ARM keyboards with default STM32 bootloader * fixed typo; added note suggestion to step 4
2018-11-02Add support for Atmega32A to pin declarations and universal matrix (#4015)Jack Humbert1-1/+1
* add computed pins from mcu type * update for atmega32a * doc typo * add atmega16 chips, link to references * remove avr include from config * exclude assembler in config.h includes * consolodate options, add 646 * fix typo in pindef
2018-10-30Update feature_bootmagic.md (#4290)Leah1-1/+1
Fix typo
2018-10-27Add Bootmagic Lite to QMK (#4215)Drashna Jaelre1-1/+51
* Preliminary additon of bootmagic lite functionality * Cleanup code * Clean up bootmagic code * Add documentation and clean up code * Make 'lite' an option for BOOTMAGIC_ENABLE * Update Templates with note about Bootmagic Lite option * Detect Debounce variable * Make sure debounce is a non-zero number * Capitalize Bootmagic * Capitalize bootmagic * Update wording * Re-add EEPROM reset, by popular demand And add eeprom-less version to drashna userspace for his sanity * Fix spacing * Set BOOTMAGIC_ENABLE to use full/lite/off And default yes to "full" for compatibility * Add Bootmagic lite info to templates * Remove text from makefiles * Cleanup of makefile * mention yes in bootmagic docs * Wordsmitthing the docs * Fix white spaces * Readd default bootmagic setting, because it's necessary
2018-10-27Docs: Add references to One Shot functions, and clean up formatting (#4189)Drashna Jaelre1-5/+12
* Docs: Add references to One Shot functions, and clean up formatting * Update PR based on @mechmerlin's recommendations
2018-10-27Add caveat for basic keycodes in Tap Dance docsDrashna Jaelre1-0/+2
2018-10-27Add key caveat to combos docDrashna Jaelre1-0/+1
2018-10-26add better exampleJack Humbert1-2/+9
2018-10-26add support for encoders to coreJack Humbert3-0/+43
2018-10-26Fix incorrect doctoring in feature.backlight.md (#4244)Phillip Tennen1-1/+1
I'm guessing someone deleted a row at some point in the past, but I didn't blame it.
2018-10-25Fix syntax for windowsDrashna Jaelre1-1/+1
2018-10-22Update the installation script PR (#4167)Drashna Jaelre1-1/+1
* Update docs to use qmk_install * Update Vagrantfile to use qmk_install
2018-10-22Add caveats for shifted characters (#4192)Drashna Jaelre2-6/+18
* Add caveats for shifted characters And some formatting and grammar corrections. Closes #1037 * Fix spelling of remote * Fix spelling error * Remote not Remove * Remote not Remove
2018-10-22Update hardware config warnings to be more accurateDrashna Jaelre1-1/+1
Closes #3565
2018-10-22Minor updates to build tools docs revised (#4195)Dylan Khor1-3/+3
* add initial khord iris keymap * correct path of windows qmk install script
2018-10-22Updates docs - planck 6 and macos instructions (#4201)Colin T.A. Gray2-0/+3
* add note about how to install rev6 (dfu-util) * include instructions on installing dfu-util on macOS
2018-10-20Add instructions for zadig when bootloader device is unknownDrashna Jaelre1-1/+9
2018-10-19Some cleanup of the Useful Functions docs (#4064)Drashna Jaelre1-14/+64
* Add examples for tri layers * Clean up and spelling fixes
2018-10-19Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning ↵noroadsleft5-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
2018-10-18Fix more broken links to the HID specChristoffer Holmberg2-2/+2
2018-10-18Fix grammar, typos, and the link to HID specificationChristoffer Holmberg1-7/+7
2018-10-16Fix doc typoJim Tittsler1-1/+1
2018-10-13Fix Typo in Custom Quantum functions document (led_state) (#4129)asakuno1-2/+2
*_LOCK   ↓ DEL
2018-10-12add a notice into docs/feature_rgblight.mdmtei1-1/+2
2018-10-11Add documentation for Combo featureDrashna Jaelre4-0/+96
2018-10-11Cleanup learning newb linksDrashna Jaelre3-8/+8
2018-10-11Update and cleanup AVR Hardware docsDrashna Jaelre1-22/+20
2018-10-10Specify max layers supported in layer keycodesDrashna Jaelre1-2/+2
2018-10-09Fix formatting in Unicode textDrashna Jaelre1-5/+5
2018-10-09Added link to One Shot KeysBrian Choromanski1-1/+1
2018-10-09Added OSL to list of layer togglesBrian Choromanski1-0/+1
2018-10-07Update Bluetooth docs (#4062)chipperdoodles2-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
2018-10-07Update and clarify Unicode documentation (#4065)Drashna Jaelre1-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
2018-10-07Update Contrib doc (#4068)Drashna Jaelre1-2/+21
* Add link for style * ignore java * Add example and update link? * Minor fixes * Change 1TBS text * comments
2018-10-05ARM SWD guideyiancar3-0/+89
- Added a detailed (but saddly long) debugging guide. - Modified sidebar and summary to include the links.
2018-10-02Add C hint to inline codeYan-Fa Li1-19/+19
2018-10-02Add send_unicode_hex_string function (#3828)Drashna Jaelre1-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
2018-10-02Add tap_code function (#3784)Drashna Jaelre1-0/+4
* Add tap_code * formatting * Doc clarification * Rename variable to make more consistent
2018-10-02Add Function level EECONFIG code for EEPROM (#3084)Drashna Jaelre1-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
2018-10-01Make digital rain RGB matrix effect #define configurable.Daniel Shields1-0/+1
2018-10-01Correct small typoAnthony Som1-1/+1
A small typo (it -> in) that I noticed while reading through the documentation