aboutsummaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)Author
2019-07-16Allow Combo feature to be enabled/disabled live (#6318)Gravatar Drashna Jaelre
* Add ability to enable/disable combos * Update documentation for Combo feature * Change keycodes for appeasement * Simplify combo_toggle function * Update names * Update combo docs to use tables
2019-07-16Add ARM I2Cv1 support to i2c_master (#6262)Gravatar Joel Challis
* Add ARM I2Cv1 support to i2c_master * Add I2Cv1 docs
2019-07-16Make Caps Lock delay more reasonable (#6199)Gravatar Drashna Jaelre
* Make Caps Lock delay more reasonable * Update documentation * Update docs/config_options.md Co-Authored-By: Konstantin Đorđević <vomindoraan@gmail.com> * Update docs/config_options.md Co-Authored-By: Konstantin Đorđević <vomindoraan@gmail.com>
2019-07-16Configure Vagrant to use qmk_base_container (#6194)Gravatar Joel Challis
* Initial conversion of vagrant to use qmkfm/base_container * Fix vagrant when using docker provider * Workaround for VirtualBox VM restarts * Generalise Vagrant docs slightly and add FAQ
2019-07-15[Docs] Add dedicated page for Split Keyboard information (#5802)Gravatar Drashna Jaelre
* [Docs] Add dedicated page for Split Keyboard information * Apply suggestions from code review Co-Authored-By: drashna <drashna@live.com> * Fix Typos Co-Authored-By: drashna <drashna@live.com> * Fix some formatting issues * Add Additional RGB info * Fix Bulletted formatting * Apply suggestions from code review Co-Authored-By: drashna <drashna@live.com> * Fix line wrapping * Additional fixes and expansion * Reword warning/note Co-Authored-By: drashna <drashna@live.com> * add i2c/serial coexistance info * i2c markdown * Change i2c wiring text Co-Authored-By: drashna <drashna@live.com>
2019-07-15Usbasploader bootloader option addition (#6304)Gravatar yiancar
* Added USBasp bootloader option for USBasploader * author comment * ifdef fix :) * Add usbasp target * Update docs/flashing.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/flashing.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/flashing.md Co-Authored-By: fauxpark <fauxpark@gmail.com>
2019-07-15QMK CLI and JSON keymap support (#6176)Gravatar skullydazed
* Script to generate keymap.c from JSON file. * Support for keymap.json * Add a warning about the keymap.c getting overwritten. * Fix keymap generating * Install the python deps * Flesh out more of the python environment * Remove defunct json2keymap * Style everything with yapf * Polish up python support * Hide json keymap.c into the .build dir * Polish up qmk-compile-json * Make milc work with positional arguments * Fix a couple small things * Fix some errors and make the CLI more understandable * Make the qmk wrapper more robust * Add basic QMK Doctor * Clean up docstrings and flesh them out as needed * remove unused compile_firmware() function
2019-07-13[Docs] Fix indented subheading on faq_debug.md (#6320)Gravatar noroadsleft
2019-07-12Documentation: Newbs Flashing: Hightlight that sudo may be needed (#6300)Gravatar Phil Schalm
* Hightlight that sudo may be needed Also added "dfu-programmer: no device present" in so that anyone searching for that particular error can hopefully find the page. * Use new style of indicating a warning * Indicate that the FAQ should be read instead of blindly using sudo
2019-07-11[Docs] Clarify the rules.mk setup for Unicode (#6286)Gravatar fauxpark
* Clarify the rules.mk setup for Unicode * code point Co-Authored-By: Konstantin Đorđević <vomindoraan@gmail.com> * Remove "your" Co-Authored-By: Konstantin Đorđević <vomindoraan@gmail.com> * Undo a line change Co-Authored-By: Konstantin Đorđević <vomindoraan@gmail.com> * dot the comma Co-Authored-By: Konstantin Đorđević <vomindoraan@gmail.com> * Update docs/feature_unicode.md Co-Authored-By: Konstantin Đorđević <vomindoraan@gmail.com>
2019-07-08Updated OLED Docs with notes about screen timeout. (#6276)Gravatar XScorpion2
* Updated OLED Docs with notes about screen timeout. * Update docs/feature_oled_driver.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
2019-07-06Added mod carry over from press to release. (#5866)Gravatar XScorpion2
Update docs/feature_space_cadet.md Co-Authored-By: fauxpark <fauxpark@gmail.com>
2019-07-01fix typoGravatar shela
2019-06-24[Docs] Reword confusing description of `TO(layer)` (#6174)Gravatar lf
* Reword confusing description of `TO(layer)` * Update docs/keycodes.md Co-Authored-By: Drashna Jaelre <drashna@live.com>
2019-06-19Fix breathing always on for soft PWM (#5983)Gravatar fauxpark
* Fix breathing always on for soft PWM * Remove reference to hardware PWM pins in BACKLIGHT_BREATHING description Now, breathing will only be unsupported when Timers 1 and 3 are both used by Audio * Document BACKLIGHT_ON_STATE and its purpose
2019-06-19Set default I2C clock speed to 100kHz for split_common (#6161)Gravatar Danny
* Set default I2C clock rate for split_common boards to 100kHz Default from I2C driver is 400kHz. * Update documentation for setting I2C clock speed
2019-06-17Fix backlight breathing on C6 (#6102)Gravatar fauxpark
* Fix backlight breathing on C6 * Account for ATmega32A's single TIMSK register (MT40) * Document hardware PWM on D4 for ATmega32A * Add C6 and D4 to BACKLIGHT_PIN description
2019-06-11Add SH1106 OLED support (#5787)Gravatar Michael F. Lamb
* modify oled_driver to support SH1106 also: - improve mechanism to specify which OLED IC we use - comment calc_bounds() - give OLED_COLUMN_OFFSET a default value - inline comment re: OLED MEMORY_MODE and SH1106 - update docs/feature_oled_driver.h for SH1106 support and related changes - docs: OLED: note we have tested SSD1306 on ARM boards (per @XScorpion2) - define out MEMORY_MODE when using SH1106 OLED driver * document that SSD1306 128x64 on AVR works Per @XScorpion2: https://github.com/qmk/qmk_firmware/pull/5787#discussion_r291837842
2019-06-11[Docs] Update feature_rgb_matrix.md (#6117)Gravatar Chris Scheib
* Update feature_rgb_matrix.md fix indentation on code comments * Update feature_rgb_matrix.md more formatting changes, missed these the first time
2019-06-07Fixing OLED Driver for 128x64 displays (#6085)Gravatar XScorpion2
2019-06-06Replace DEBOUNCING_DELAY (deprecated) with DEBOUNCE (#5997)Gravatar Drashna Jaelre
2019-06-06use twitter card large setting for larger previewsGravatar Jack Humbert
2019-06-06add type:object to docs meta info (github uses it)Gravatar Jack Humbert
2019-06-06Add meta tags for docsGravatar Jack Humbert
2019-06-05Change from avr-gcc@7 to @8 for MacGravatar Danny Nguyen
2019-06-05[Docs] Make Code Examples Consistent On Combo Page (#6078)Gravatar Alex Mayer
2019-06-04docs to Mandarin Chinese (#5960)Gravatar ymzcdg
* faq_general.md to Chinese faq_general.md to Chinese faq finished * custom_quantum_functions.md to Chinese custom_quantum_functions.md to Chinese * custom_quantum_functions.md fix custom_quantum_functions.md fix * custom_quantum_functions.md fix translate custom_quantum_functions.md fix translate * !ver.English! _summary.md bug fix _summary.md bug fix of English doc. add".md" behind "feature_combo" * !ver.English! custom_quantum_functions.md fix#5869 custom_quantum_functions.md in English : delete redundant "is" . issue#5869 * !ver.English! how_keyboards_work.md link fix change https://en.wikipedia.org/wiki/Unicode_input#Hexadecimal_code_input to https://en.wikipedia.org/wiki/Unicode_input#Hexadecimal_input "#Hexadecimal_code_input" not exist * !English! how_keyboards_work.md add missing "t" Tied to a specific OS a a time (need recompilation when changing OS); change to Tied to a specific OS at a time (need recompilation when changing OS); * _summary.md improve translation _summary.md improve translation * reference_glossary.md into Chinese reference_glossary.md into Chinese 术语表翻译,这个术语表英文版似乎不太全,应该补充英文版,并在中文版添加其他具有中国特色的术语。
2019-06-04Add missing links to features page and sidebar section (#5949)Gravatar Jack Humbert
* Add missing links to features page and sidebar section * Fix links Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Additional link fixes Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Fix typo
2019-06-01Parameterise STM32 I2C pin modes and timing parameters. (#5671)Gravatar Nick Brassel
I2C timing parameters were seemingly set up for an STM32F303 target MCU, at a specific clock speed. This commit allows specifying the timing parameters via config.h, allowing other STM32 MCUs to be targeted, potentially at different clock frequencies. Alternate function modes for the I2C pins are now also configurable, allowing for remapping to other pins.
2019-05-31[Docs] Update getting_started_introduction.md (#6037)Gravatar Elliot Powell
* Update getting_started_introduction.md * Update docs/getting_started_introduction.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update docs/getting_started_introduction.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update docs/getting_started_introduction.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update docs/getting_started_introduction.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
2019-05-31Update reference_configurator_support.mdGravatar Elliot Powell
We no longer auto generate bootloader into info.json through the website therefore this can be removed
2019-05-30Update feature_encoders.mdGravatar Elliot Powell
Fix missing closing comment after second encoder
2019-05-25Document MT keycode in keycodes.mdGravatar fauxpark
2019-05-23Fix typoGravatar Drashna Jaelre
2019-05-22Additional link fixesGravatar Drashna Jaelre
Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
2019-05-22Fix linksGravatar Drashna Jaelre
Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
2019-05-22translate docs into Mandarin Chinese (#5890)Gravatar ymzcdg
* translate docs into Mandarin Chinese translate faq_debug.md into Chinese * translate faq_build.md into Chinese translate faq_build.md into Chinese * faq_keymap.md to zh-cn faq_keymap.md to zh-cn
2019-05-21Add missing links to features page and sidebar sectionGravatar Drashna Jaelre
2019-05-19Added custom center point to rgb matrixGravatar Ryan Caltabiano
2019-05-19Spirals, Pinwheels, and Documentation....Oh My! RGB Matrix Effects (#5877)Gravatar XScorpion2
* Spirals, Pinwheels, and Documentation....Oh My! * Spiral effect band thickness adjustments * Fixing animation spin directions
2019-05-19Single Color Band scrolling left to right effects (#5867)Gravatar XScorpion2
2019-05-17Adds a configurable initial delay to the audio clicky feature (#4286)Gravatar Josh
* Adding an AUDIO_CLICKY_DELAY_DURATION configurable value to the AUDIO_CLICKY feature. * Tweaking my community keymap to work better with my rev 4 planck.
2019-05-16Make delay for Capslock in Hold-Tap functions configurable (#5497)Gravatar Drashna Jaelre
* Increase delay for Hold-Tap register for CAPSLOCK Because it seems that the 80ms delay wasn't too much * Screw it, make the caps delay a define and make it configurable
2019-05-16[Docs] Fix typo in Userspace doc (#5871)Gravatar Pavlos Vinieratos
* typo * Update docs/feature_userspace.md Co-Authored-By: fauxpark <fauxpark@gmail.com>
2019-05-15Add effect range to rgblight.c (#5856)Gravatar Takeshi ISHII
* add rgblight_set_effect_range() * implement effect range * Arrange the order of function list in rgblight.h . * update docs/feature_rgblight.md * fix RGBLIGHT_RAINBOW_SWIRL_RANGE default value * add example code about Utility Functions * add example code about direct operation functions * When RGBLIGHT_SPLIT is defined, the following function has no meaning and is invalidated. * rgblight_setrgb_master(r, g, b) * rgblight_setrgb_slave(r, g, b) * rgblight_sethsv_master(h, s, v) * rgblight_sethsv_slave(h, s, v) * add temporary test code for rgblight_set_effect_range * fix rgblight_effect_knight() bug * Test End. Revert "add temporary test code for rgblight_set_effect_range" This reverts commit 5680cddd012d68b2db75a532862a7fef250f8973.
2019-05-11Added check for event pressed to clear space cadet (#5839)Gravatar XScorpion2
* Added check for pressed to clear space cadet * Found some docs to update * Update docs/quantum_keycodes.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Changes from PR
2019-05-11translate docs into Mandarin Chinese (#5807)Gravatar ymzcdg
* translate newbs.md into Madarin Chinese translate newbs.md into Madarin Chinese * translate docs into Mandarin Chinese translate getting_started_github.md into Mandarin Chinese * translate getting_started_getting_help.md into Mandarin Chinese translate getting_started_getting_help.md into Mandarin Chinese * contributing.md to Chinese Personify QMK as a girl named Q酱 . It can make more developer read this document and contribute QMK. * getting_started_introduction.md to Chinese getting_started_introduction.md to Chinese * faq.md to Chinese faq.md to Chinese * crlf2lf getting_started_introduction.md ending line fix getting_started_introduction.md * crlf2lf contributing.md crlf2lf contributing.md
2019-05-10RGB Matrix Effects: Cycle Out to In & Cycle Out to In Dual (#5812)Gravatar XScorpion2
2019-05-10Cleanup/rgb matrix (#5811)Gravatar XScorpion2
* clean up rgb matrix extern usage Moved rgb matrix boiler plate into macros Rebased onto typing heatmap pr * Fixing the reversed frame buffer access in digital rain * Fixing digital rain & typing heatmap if keyreactive effects are not enabled * Apply suggestions from code review Co-Authored-By: Drashna Jaelre <drashna@live.com> * Adding parenthesizes to DRIVER_LED_TOTAL where necessary * Updated docs * added notes about parentheses
2019-05-10[Docs] RGB Animation documentation on reducing memory footprint (#5813)Gravatar Yan-Fa Li
* Improve Animation docs with example - example to reduce flash footprint of animations using RGBLIGHT_EFFECT_ defines * Re-order the effects list * Update docs/feature_rgblight.md Co-Authored-By: yanfali <yanfali@gmail.com> * Update docs/feature_rgblight.md Co-Authored-By: yanfali <yanfali@gmail.com> * Update docs/feature_rgblight.md Co-Authored-By: yanfali <yanfali@gmail.com> * Introduce line breaks * Add title for animation speed section * Organize Animation Defines Into Groups * Use the RGB EFFECT recommended by mtei in docs - has the most modes, and STATIC_LIGHT can't really be disabled. * Use more accurate titles for effects and animation - accidentally put a toggle in settings