summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2019-08-21Additional changes for Layer State typedef compatibility (#5906)Drashna Jaelre
* Additional changes for Layer State typedef compatibility * Replace biton32 with get_highest_layer in docs * Change additional layer structure code * Fix uGFX reference issue * Remove dynamic_keymap check * Where did all these extra spaces come from Co-Authored-By: fauxpark <fauxpark@gmail.com>
2019-08-21Added keycodes for swapping and unswapping the Control and OS keys (#6110)Stephen Wanhella
* Add MAGIC_SWAP_CONTROL_LGUI and MAGIC_UNSWAP_CONTROL_LGUI keycodes Key codes to swap and unswap the control and windows/cmd keys * Fix issues with pull request #6110 Renamed swap/unswap lctl and lgui key codes, added key codes to swap/unswap rctl and rgui, and moved new bool inside keycode_config.h struct to the end * Move new keycodes to the end of the enum (#6110) * add cases for swapped control and OS keys to mod_config (#6110) * Add new keycodes to feature_bootmagic.md (#6110) * Add R+L swap codes to keep in parity with AG_* codes * Extend Magic range check to include new magic codes * Update audio docs * Combine 2 byte ranges into 1 word for EECONFG Fix names for Keymap config EEPROM * Update docs/feature_bootmagic.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update docs/feature_bootmagic.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update docs/feature_bootmagic.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update docs/feature_bootmagic.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
2019-08-20Remove superfluous JTAG disable code (#6445)fauxpark
* Remove superfluous JTAG disable code * 32A has differently named register * Accidentally some operators * 32A also has different JTAG pins * Wrap disable_jtag() in an ifndef * Document this new define * Rename the define, it conflicts with a LUFA thing Also, move the ifndef wrapping to the call in keyboard_setup()
2019-08-19[Docs] Add RGB Matrix default mode define info (#6564)Drashna Jaelre
2019-08-17Reword a note about the MANUFACTURER and PRODUCT defines in hardware_avr.md ↵fauxpark
(#6558)
2019-08-16Add support for different encoder pinout for right half of split keyboard ↵Danny
(#6521) * Add support for different encoder pinouts for split keyboard * Update documentation for new encoder pinout feature
2019-08-08Improve backlight PWM pin support (#6202)fauxpark
* Improve backlight PWM pin support * I accidentally an equals sign * Another typo * Order by pin number * Throw an error if backlight pin is C4 or C5 on 16/32U4 * Use else for clarity * Minor alignment adjustments
2019-08-08Change "yu" to "you" in combo docs (#6510)Michael Clayton
2019-08-03[Split] Add config option for DIRECT_PINS_RIGHT (#6479)Garrett Singer
Adds support for different direct pin mappings on the halves of a split keyboard.
2019-08-01[Docs] Add dfu-util and caterina udev examples (#6429)Joel Challis
2019-07-31Fix typo for building Ergodox EZ keyboards (#6453)Rasmus Lindroth
2019-07-29Update YouTube URLZachary J. Slater
The link was an outdated one to https://www.youtube.com/watch?v=7RH-1pAbjvw The correct link appears to be https://www.youtube.com/watch?v=tx54jkRC9ZY which is shortened as in the file.
2019-07-25[Docs] Add Sections and MO(layer)/TG(layer) Example (#6308)thomas-d-11
* Add Sections and MO(layer)/TG(layer) Example Major changes: 1. Added sub-section headings to the portion before the examples. 2. Added a new Example 6, that allows MO(layer) and TG(layer) functionality to be embedded within tap dance functions. Minor Changes: 1. Edited some text to better fit with new sub-headings. * Update feature_tap_dance.md * Update feature_tap_dance.md
2019-07-20Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348)Konstantin Đorđević
* Update IS_COMMAND definition in templates to use MOD_MASK_SHIFT * Update IS_COMMAND in docs * Update IS_COMMAND default definition in tmk_core * Update table in Command docs based on suggestion Co-Authored-By: fauxpark <fauxpark@gmail.com>
2019-07-19[Docs] Clarify Zadig usage in FAQ Docs (#6360)Drashna Jaelre
* Rewrite Zadig section to be more clear * Wordsmithing Co-Authored-By: MechMerlin <30334081+mechmerlin@users.noreply.github.com>
2019-07-18Correct backlight on state docs (#6358)fauxpark
* Correct backlight on state docs * Reword to make it less confusing
2019-07-16Extend maximum number of backlight levels to 31 (#6351)fauxpark
2019-07-16Remove the need to specify NUM_OF_ENCODERS for the Encoder feature (#6328)Drashna Jaelre
* Remove the need to set NUM_OF_ENCODERS Instead, calculate the size of the array, and use that instead * Add hack for split common support * Remove NUM_OF_ENCODERS from keyboard config Can be reverted, if needed
2019-07-16Allow Combo feature to be enabled/disabled live (#6318)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)Joel Challis
* Add ARM I2Cv1 support to i2c_master * Add I2Cv1 docs
2019-07-16Make Caps Lock delay more reasonable (#6199)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)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)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)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)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)noroadsleft
2019-07-12Documentation: Newbs Flashing: Hightlight that sudo may be needed (#6300)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)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)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)XScorpion2
Update docs/feature_space_cadet.md Co-Authored-By: fauxpark <fauxpark@gmail.com>
2019-07-01fix typoshela
2019-06-24[Docs] Reword confusing description of `TO(layer)` (#6174)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)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)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)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)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)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)XScorpion2
2019-06-06Replace DEBOUNCING_DELAY (deprecated) with DEBOUNCE (#5997)Drashna Jaelre
2019-06-06use twitter card large setting for larger previewsJack Humbert
2019-06-06add type:object to docs meta info (github uses it)Jack Humbert
2019-06-06Add meta tags for docsJack Humbert
2019-06-05Change from avr-gcc@7 to @8 for MacDanny Nguyen
2019-06-05[Docs] Make Code Examples Consistent On Combo Page (#6078)Alex Mayer
2019-06-04docs to Mandarin Chinese (#5960)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)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)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)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.mdElliot Powell
We no longer auto generate bootloader into info.json through the website therefore this can be removed
2019-05-30Update feature_encoders.mdElliot Powell
Fix missing closing comment after second encoder
generated by cgit v1.2.1 (git 2.18.0) at 2024-11-23 13:54:57 +0000