summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2020-12-23Updated Raw HID docs to clarify packet/report length (#11211)Kishor Prins
Co-authored-by: Ryan <fauxpark@gmail.com>
2020-12-18Updated usage of qmk c2json (#11148)precondition
2020-12-16CLI-ify rgblight_breathing_table_calc.c (#11174)Ryan
Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> Co-authored-by: Zach White <skullydazed@drpepper.org>
2020-12-14Add i2c 24LC64 eeprom (#11200)Xelus22
* add 24LC64 eeprom * docs update * Update docs/eeprom_driver.md Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Joel Challis <git@zvecr.com>
2020-12-11Normalise include statements in core code (#11153)Ryan
* Normalise include statements in core code * Missed one
2020-12-06add definition WS2812_BYTE_ORDER to fix RGB LED issues (#10184)Josh Hinnebusch
* add define for WS2812B-2020 to fix RGB issues * update driver doc * add WS2812_BYTE_ORDER definition to correct RGB byte issues * add definition variable thing * update per PR request * update per PR reqs * update per PR request * inital changes * move defines to color.h and add rgbw incase * Update docs/ws2812_driver.md Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: hineybush <hineybushkeyboards@gmail.com> Co-authored-by: Xelus22 <preyas22@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
2020-11-282020 November 28 Breaking Changes Update (#11053)James Young
* Branch point for 2020 November 28 Breaking Change * Remove matrix_col_t to allow MATRIX_ROWS > 32 (#10183) * Add support for soft serial to ATmega32U2 (#10204) * Change MIDI velocity implementation to allow direct control of velocity value (#9940) * Add ability to build a subset of all keyboards based on platform. * Actually use eeprom_driver_init(). * Make bootloader_jump weak for ChibiOS. (#10417) * Joystick 16-bit support (#10439) * Per-encoder resolutions (#10259) * Share button state from mousekey to pointing_device (#10179) * Add hotfix for chibios keyboards not wake (#10088) * Add advanced/efficient RGB Matrix Indicators (#8564) * Naming change. * Support for STM32 GPIOF,G,H,I,J,K (#10206) * Add milc as a dependency and remove the installed milc (#10563) * ChibiOS upgrade: early init conversions (#10214) * ChibiOS upgrade: configuration file migrator (#9952) * Haptic and solenoid cleanup (#9700) * XD75 cleanup (#10524) * OLED display update interval support (#10388) * Add definition based on currently-selected serial driver. (#10716) * New feature: Retro Tapping per key (#10622) * Allow for modification of output RGB values when using rgblight/rgb_matrix. (#10638) * Add housekeeping task callbacks so that keyboards/keymaps are capable of executing code for each main loop iteration. (#10530) * Rescale both ChibiOS and AVR backlighting. * Reduce Helix keyboard build variation (#8669) * Minor change to behavior allowing display updates to continue between task ticks (#10750) * Some GPIO manipulations in matrix.c change to atomic. (#10491) * qmk cformat (#10767) * [Keyboard] Update the Speedo firmware for v3.0 (#10657) * Maartenwut/Maarten namechange to evyd13/Evy (#10274) * [quantum] combine repeated lines of code (#10837) * Add step sequencer feature (#9703) * aeboards/ext65 refactor (#10820) * Refactor xelus/dawn60 for Rev2 later (#10584) * add DEBUG_MATRIX_SCAN_RATE_ENABLE to common_features.mk (#10824) * [Core] Added `add_oneshot_mods` & `del_oneshot_mods` (#10549) * update chibios os usb for the otg driver (#8893) * Remove HD44780 References, Part 4 (#10735) * [Keyboard] Add Valor FRL TKL (+refactor) (#10512) * Fix cursor position bug in oled_write_raw functions (#10800) * Fixup version.h writing when using SKIP_VERSION=yes (#10972) * Allow for certain code in the codebase assuming length of string. (#10974) * Add AT90USB support for serial.c (#10706) * Auto shift: support repeats and early registration (#9826) * Rename ledmatrix.h to match .c file (#7949) * Split RGB_MATRIX_ENABLE into _ENABLE and _DRIVER (#10231) * Split LED_MATRIX_ENABLE into _ENABLE and _DRIVER (#10840) * Merge point for 2020 Nov 28 Breaking Change
2020-11-27[Docs] Add VBUS hack for teensys (#10986)Drashna Jaelre
2020-11-26Refactor qmk_install.sh (#10681)Ryan
2020-11-18Update one_shot_keys.md (#10917)j-zero
MOD_RSFT doesn't work. See: https://github.com/qmk/qmk_firmware/issues/10901
2020-11-16Recommend use of LED Indicator config (#10895)Joel Challis
* Recommend use of LED Indicator config * Recommend use of LED Indicator config - update link * Update quantum/template/ps2avrgb/config.h Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
2020-11-10CI: Add docs build and deploy workflow (#7448)Joel Challis
* Add docs build and deploy workflow * Remove old travis docs workflow * update to cli command * Tidy up for review * formatting * Update to pass style checks * Update lib/python/qmk/cli/docs.py Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com> * Review comments - build->generate, use of verbose * Add docs * Update to match recent actions * Run within base_container * Convert cli to generate-docs * Convert cli to generate-docs - restore old file * Convert cli to generate-docs * Update docs Co-authored-by: skullydazed <skullydazed@users.noreply.github.com>
2020-11-10Added color wheel that have QMK HSV values. (#8997)elijahblake81
I've converted the 360 color wheel to the 255 color wheel for QMK HSV values.
2020-11-09[Docs] redirect from /tutorial to /newbs (#10718)Mikkel Jeppesen
* Added redirect from /tutorial to /newbs * Fixed indentation * Changed title of tutorial page
2020-11-10Adding few Korean translated files (#5895)SeungheonOh
* Korean Translation Korean Translation * Korean translation * more Korean translations
2020-11-08Indicator LEDs as config (#10816)Joel Challis
* First pass * Add config options to docs * Update some wording * Slight tidy up of backlight caps logic * Init pin to correct state * Move init location * Reverse default state
2020-11-07New command: qmk lint (#10761)Zach White
* Basic qmk lint command * check for keymap readme * change the workflow from qmk info to qmk lint * add a strict mode * parsing -> parse * document qmk lint * small info logging cleanup * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> * honor --strict in more places * change the job name to lint Co-authored-by: Ryan <fauxpark@gmail.com>
2020-11-04CLI: Add `qmk clean` (#10785)Ryan
2020-10-29Add brightness level API to OLED driver (#10772)Ryan
* Add brightness level API to OLED driver * Set default brightness to 255
2020-10-18Add last breaking changes log to sidebar (#10680)Drashna Jaelre
Co-authored-by: Ryan <fauxpark@gmail.com>
2020-10-1750-qmk.rules: Move udev rules from documentation into a file (#10664)Morten Linderud
This makes it overall easier to package for downstream distributions instead of keeping tabs with inline documentation. Signed-off-by: Morten Linderud <morten@linderud.pw>
2020-10-18[Docs] add "Adding Default Keymaps to QMK Configurator" doc (#10049)James Young
2020-10-18MSYS and WSL installation improvements (#10593)Ryan
2020-10-17[Docs] Update feature_combo.md of Japanese document (#10671)shela
2020-10-15[Docs] Add link to Tap-Hold Configuration Options from Mod-Tap (#10548)Andre Azzolini
2020-10-15Update other_vscode.md of Japanese document (#10604)shela
* Update Japanese document * Fix inline code * Update docs/ja/other_vscode.md Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
2020-10-14Update Japanese document (#10607)shela
2020-10-14[Docs] Japanese translation of docs/pr_checklist.md (#10415)Takeshi ISHII
* japanese translation of docs/pr_checklist.md * update docs/ja/pr_checklist.md * update docs/ja/pr_checklist.md * update docs/ja/pr_checklist.md * add :id=lite to docs/ja/custom_matrix.md * add :id=... to docs/ja/custom_quantum_functions.md * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md * Update docs/ja/pr_checklist.md * Update docs/ja/pr_checklist.md Co-authored-by: s-show <s1shimz@gmail.com> * Update docs/ja/pr_checklist.md Co-authored-by: s-show <s1shimz@gmail.com> Co-authored-by: shela <shelaf@users.noreply.github.com> Co-authored-by: s-show <s1shimz@gmail.com>
2020-10-13Update tags to check for document updates (#10606)shela
2020-10-13Fix typo within debounce documentation (#10600)shela
2020-10-13Update Japanese document (#10605)shela
2020-10-13Update Japanese document (#10601)shela
2020-10-13Update Japanese document. (#10599)shela
2020-10-13Update feature_bluetooth.md of Japanese document. (#10594)shela
* Update Japanese document. * Left justified. * Update docs/ja/feature_bluetooth.md Co-authored-by: s-show <s1shimz@gmail.com> * Update docs/ja/feature_bluetooth.md Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> Co-authored-by: s-show <s1shimz@gmail.com> Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
2020-10-13Update Japanese document. (#10589)shela
2020-10-13Update Japanese document (#10603)shela
2020-10-13[Docs] Japanese translation of docs/isp_flashing_guide.md (#9896)Takeshi ISHII
* start translation docs/ja/isp_flashing_guide.md * Japanese translation is in progress. * Japanese translation is in progress. * Japanese translation is in progress. * Japanese translation is in progress. * Japanese translation is in progress. * Japanese translation is in progress. * Japanese translation is in progress. * update docs/ja/isp_flashing_guide.md * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: Takuya Urakawa <urkwtky@gmail.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: Takuya Urakawa <urkwtky@gmail.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: Takuya Urakawa <urkwtky@gmail.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: Takuya Urakawa <urkwtky@gmail.com> Co-authored-by: shela <shelaf@users.noreply.github.com> Co-authored-by: Takuya Urakawa <urkwtky@gmail.com>
2020-10-13changed type of process_combo_event argument in tutorial (#10621)Jan-Frederick Musiol
in tutorial for combos feature, changed type of compo_index argument of process_combo_event form uint8_t to uint16_t
2020-10-10Update feature_backlight.md of Japanese document. (#10592)shela
* Update Japanese document. * Update tag
2020-10-10Update Japanese document. (#10591)shela
2020-10-10Update Japanese document. (#10590)shela
2020-10-10Update Japanese document. (#10588)shela
2020-10-06Docs: fix udev rulesErovia
Apparently, udev does not like inline comments. Rules with them are ignored, oops.
2020-10-06[CLI] Add c2json (#8817)Erovia
* Basic keymap parsing finally works * Add 'keymap.json' creation to the qmk.keymap module * Add tests and fix formatting * Fix/exclude flake8 errors * Convert keymap.c to valid keymap.json * Fix some errors * Add tests * Finalize keymap.json creation, add json template * Add docs * Move pygments to the standard requirements * Add support for nameless layers, fix tests * Fix things after rebase * Add missing 'keymap' value. * Fix missing layer numbers from advanced keycodes Buckwich noticed that if the advanced keycode / layer toggling key contains a number, it goes missing. Now we properly handle them. Thx for noticing! * Apply suggestions from code review * fixup tests Co-authored-by: Zach White <skullydazed@drpepper.org> Co-authored-by: skullY <skullydazed@gmail.com>
2020-10-05Fixes small typo in docs (#10515)Joe Strong
2020-10-03Mark 'key_count' as optional within info.json docs (#10513)George Mao
* Update reference_info_json.md key_count is now an optional field because it is better to get the keycount by counting the elements in the layout array. * Updated Japanese documentation as well
2020-10-01Doc followup 9942 (#10473)nopunin10did
* Update feature_advanced_keycodes.md * Update mod_tap.md
2020-09-27Consolidate udev rules into a single file (#9693)Ryan
* Consolidate udev rules into a single file * Update rules in doctor.py * Simplify doctor rule checking * Fix errors * Add TMK "FEED" VID to list of deprecated udev rules * A comma would be nice * Split rules back up into bootloaders * Link to docs page in "missing" case * Add Pololu VID * Be more specific about Caterina devices, and add LilyPad PID
2020-09-26[Docs] Wording & formatting changes in the Tapping Force Hold section of the ↵precondition
Tap Hold page + removed trailing whitespaces (#10391) * Wording & formatting changes in Tapping Force Hold The Permissive Hold and the Ignore Mod Tap Interrupt sections were also modified to remove the quotes around "tapping". * Removed all trailing whitespaces from tap hold doc * "it's simply really:" → "it's simple really:" * "This allows to keep the ability" → "This allows keeping the ability" Used the gerund form of "to keep" in the Tapping Force Hold section of the Tap Hold docs. Co-authored-by: ridingqwerty <george.g.koenig@gmail.com> Co-authored-by: ridingqwerty <george.g.koenig@gmail.com>
2020-09-22[Docs] Japanese translation of docs/understanding_qmk.md (#10136)umi
* add understanding_qmk.md translation * update based on comment * update based on comment * update based on comment * update based on comment * update based on comment