summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2020-03-01[Docs] Update ISP Flashing guide (#8149)Drashna Jaelre
* [Docs] Update ISP Flashing guide * Apply suggestions from code review AKA why you shouldn't write docs at 2am Co-Authored-By: fauxpark <fauxpark@gmail.com> Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> * Update workding for planck-qmk-dfu Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
2020-02-29Fix the Breaking Changes doc againJames Young
WHAT YEAR IS IT?!
2020-02-29[Docs] translated 'feature_tap_dance.md' to japanese. (#8137)s-show
* complete translation. * Update docs/ja/feature_tap_dance.md Update the file based on the suggestions. * Update docs/ja/feature_tap_dance.md Update the file based on the suggestions. * Apply suggestions from code review Update the file based on the suggestions. * Apply suggestions from code review Update the file based on the suggestions (Part 2). * Apply suggestions from code review Update the file based on the suggestions (Part 3). * Apply suggestions from code review Update the file based on the suggestions (Part 3). * Apply suggestions from code review Update the file based on the suggestions (Part 4). * Apply suggestions from code review Update the file based on the suggestions (Part 5). ご提案いただいた修正案は全て確認できました。 続いて、コメント行の調整、「打つ・叩く」の変更、その他の修正を行います。 * fixed typo. * Update the file based on the suggestions (Part 6). * Update the file based on the suggestions (Part 7). * Fixed sentence. * Update docs/ja/feature_tap_dance.md Update the file based on the suggestions (Part 8). * Update the file based on the suggestions (Part 9). Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com> Co-Authored-By: shela <shelaf@users.noreply.github.com>
2020-03-01PWM DMA based RGB Underglow for STM32 (#7928)Joel Challis
* Add pwm ws2812 driver * Add docs for pwm ws2812 driver * Update ws2812_pwm for ChibiOS 19 Co-Authored-By: Nick Brassel <nick@tzarc.org> Co-authored-by: Nick Brassel <nick@tzarc.org>
2020-02-29Breaking Changes documentation fixesJames Young
2020-02-292020 February 29 Breaking Changes Update (#8064)James Young
2020-02-27Update Breaking Changes checklistJames Young
2020-02-27Update Breaking Changes timelineJames Young
I've been working from one timeline while the docs said something different.
2020-02-27Add support for delays in send_string. (#8244)Nick Brassel
2020-02-25New feature: PERMISSIVE_HOLD_PER_KEY (#7994)ridingqwerty
* Implement 'PERMISSIVE_HOLD_PER_KEY' * Document 'PERMISSIVE_HOLD_PER_KEY' Co-authored-by: GeorgeKoenig <35542036+GeorgeKoenig@users.noreply.github.com>
2020-02-25`send_unicode_string()`: Add support for code points > 0xFFFF (#8236)Ryan
2020-02-24A proper `send_string()` for the Unicode feature (#8155)Ryan
2020-02-23Add link to "Useful functions" in macro docs (#7446)Jez Cope
* Add link to "Useful functions" in macro docs Help people find additional features they can activate within a macro * Update docs/feature_macros.md Co-Authored-By: Drashna Jaelre <drashna@live.com> Co-authored-by: skullydazed <skullydazed@users.noreply.github.com> Co-authored-by: Drashna Jaelre <drashna@live.com>
2020-02-22New functionality for cformat (#7893)Akaash Suresh
Fixing complexity remove lambda PR review fixes #1 Removing unneccesary string substitution Handle -a and specified files Complexity rewrite, use pathlib
2020-02-21Allow 30us matrix delay to be keyboard/user overridable (#8216)Joel Challis
* Allow 30us matrix delay to be configurable via define * Move wait logic to matrix_common * Move wait logic to matrix_common - fix wait includes
2020-02-17[Docs] Update Japanese translation of cli.md (#8188)shela
2020-02-17[Docs] Update Japanese translation (#8129)shela
* Update Japanese translation * Update Japanese translation Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
2020-02-17[Docs] add japanese translation (detail guide part) (#7722)umi
* add detail-guide part * some updates for easy reading * some updates for easy reading * some updates for easy reading * some updates for easy reading * some updates for easy reading * some updates for easy reading * some updates for easy reading * some updates for easy reading * update file based on comment * update file based on comment * update file based on comment * update git command in header * update files based on comments, and update git command in header * update file based on comment * update file based on comment * update file based on comment * update file based on comment * update file based on comment * update file based on comment * update file based on comment * update file based on comment Co-Authored-By: shela <shelaf@users.noreply.github.com> Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
2020-02-16Convert f072 backlight build error to message (#8177)Joel Challis
2020-02-15Drop bs4 dependency, update docs, minor improvementsErovia
2020-02-15Another major refactoring, add documentationErovia
Move all useful functions to the qmk module and use the cli subcommand as a wrapper around it. Add both inline comments and documentation.
2020-02-11Fix out of bound OLED font access (#8145)Ted M Lin
* Fix out of bound OLED font access The default font is 1344 bytes, or a total of 224 glyphs (each 6-bytes wide). OLED_FONT_END defaults to 224, which if used will then index off the end of the font array. So either the documentation or code is wrong. Instead of figuring out the rewording of the documentation, just change the OLED_FONT_END default value to 223, to match the documentation and code. * Add static assert to check array size Build bomb if the font array size doesn't match to the defines.
2020-02-11[Docs] doc update zh-cn (#8147)ymzcdg
* update zh-cn translate Timestamp was added at the end of the document, it can help me manage version easier. * fix _summary.md to utf-8 * fix _summary.md with vscode
2020-02-11Align max backlight level in docs (#8142)Joel Challis
2020-02-07Add QMK Compile Context Sensitivity (#6884)Cody Bender
* Add context sensitive compile, without config check * Initial full working state. Plan to refactor * Refactor loop for simplicity, add comments * Update docs/cli.md with qmk compile examples * Simplify path for keyboard derivation * Update path to use path.join instead of concat * Refactor keyboard path, the skully way * Add in keymap folder support * Add /layouts compile support * Update docs/cli.md with empty compile in layouts * Add comments to compile.py * Update docs for clarity, and fix compile error typo * Fix config option compile * Fix layout compile and failure mode * Add rules.mk check * Fix variable names for global config * Add in_layout priority * Remove default fallback in favor of throw, update docs * Add keymap folder context * Fix formatting * Add os import * Convert to create_make_command * Fix Travis lint errors * Remove blank line with whitespace * Add blank lines for readability * Remove unnecessary config logic * Update Docs to add flash Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com> * Shift config precedence to MILC Co-authored-by: skullydazed <skullydazed@users.noreply.github.com>
2020-02-07Move Grave Escape, Lock and Leader keycodes into their own sect… (#8093)fauxpark
2020-02-04Reduce SPLIT_USB_TIMEOUT by 500ms (#7637)Joel Challis
* Update SPLIT_USB_TIMEOUT -500ms * Align keyboard level SPLIT_USB_TIMEOUT defaults * Align keyboard level SPLIT_USB_TIMEOUT_POLL * Review fixes
2020-02-01[Docs] future branch housekeepingJames Young
2020-01-27[Docs] Update Japanese translation (#8015)shela
2020-01-25suggestions by skullydazedJames Young
2020-01-25change Instructions listing in Docs summaryJames Young
2020-01-25add Breaking Change PR Instructions docJames Young
2020-01-24Beef up how `qmk doctor` works. (#7375)skullydazed
* Beef up how `qmk doctor` works. * improve the `git submodule status` parsing. h/t @erovia * Fix whitespace and imports * yapf * Add documentation for the new doctor functionality * Replace type_unchanged() with str() * remove unused modules * Update lib/python/qmk/cli/doctor.py Co-Authored-By: Erovia <Erovia@users.noreply.github.com> Co-authored-by: Erovia <Erovia@users.noreply.github.com>
2020-01-24Add customisable EEPROM driver selection (#7274)Nick Brassel
- uprintf -> dprintf - Fix atsam "vendor" eeprom. - Bump Kinetis K20x to 64 bytes, too. - Rollback Kinetis to 32 bytes as partitioning can only be done once. Add warning about changing the value. - Change RAM-backed "fake" EEPROM implementations to match eeconfig's current usage. - Add 24LC128 by request.
2020-01-19[Docs] Misc cleanups for OLED documentation (#7864)fauxpark
2020-01-18Configuration values for starting HSV and speed (#7740)Rob Haswell
* Define default HSV and speed for RGB matrix. * Documentation for configuration values RGB_MATRIX_STARTUP_HUE, RGB_MATRIX_STARTUP_SAT and RGB_MATRIX_STARTUP_VAL. * Document RGB_MATRIX_STARTUP_SPD. * Preserve the ordering.
2020-01-18Add docs for 'CUSTOM_MATRIX = lite' (#7906)Joel Challis
* Add some docs to cover 'CUSTOM_MATRIX = lite' * Apply suggestions from code review Co-Authored-By: fauxpark <fauxpark@gmail.com> * Add 'SRC += matrix.c' docs * Update docs/custom_matrix.md Co-Authored-By: fauxpark <fauxpark@gmail.com> Co-authored-by: fauxpark <fauxpark@gmail.com>
2020-01-17Implement and document TAPPING_FORCE_HOLD_PER_KEY (#7859)ridingqwerty
* Implement and document TAPPING_FORCE_HOLD_PER_KEY * Added "record" parameter to "get_tapping_force_hold" * Correct typo -- remove 'IGNORE_' from 'IGNORE_TAPPING_FORCE_HOLD_PER_KEY' Co-authored-by: GeorgeKoenig <35542036+GeorgeKoenig@users.noreply.github.com>
2020-01-14Add a note explaining how to run testsskullY
2020-01-14Add a section on python testsskullY
2020-01-14Move Space Cadet keycodes to their own section in keycode reference (#7889)fauxpark
2020-01-10Add per-key IGNORE_MOD_TAP_INTERRUPT feature (#7838)zk-phi
* Implement IGNORE_MOD_TAP_INTERRUPT_PER_KEY - Add configurable option IGNORE_MOD_TAP_INTERRUPT_PER_KEY - Add function get_ignore_mod_tap_interrupt iff the option is enabled Unless IGNORE_MOD_TAP_INTERRUPT_PER_KEY is defined, this patch does not affect the resulting binary. * Add documentation for IGNORE_MOD_TAP_INTERRUPT_PER_KEY
2020-01-10Fix docker script and document (#7786)shela
Fixed error when keyboard parameter is omitted in interactive mode.
2020-01-09Update Breaking Changes doc timelineJames Young
2020-01-07RGB matrix effect - left-right gradient (#7742)Rob Haswell
* Left-right gradient. * Update the comment to match the new functionality. * CPP does integer division so this round is not necessary. * The x-range is actually 224, update comment and use bit-shifting again. * Update docs with gradient left-right effect and associated "DISABLE" option.
2020-01-05[Docs] Update check commands in Japanese documents (#7787)Takeshi ISHII
The Japanese documents included a sample command to check the original document changes. But there was something wrong, so I fixed it.
2020-01-04Update Breaking Changes doc for 2020-02-29 mergeJames Young
2020-01-03[Docs] fix installation commands for macos (#7785)shela
* [Docs] fix installation commands for macos * Update docs/getting_started_build_tools.md
2020-01-03[Docs] Update Japanese translation (#7783)shela
* [Docs] Update translation * Apply suggestions from code review * Update docs/ja/config_options.md * Update docs/ja/newbs_building_firmware.md Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
2020-01-02[Docs] Added description of LIB_SRC to docs/config_options.md (#7765)Takeshi ISHII
And LINK_TIME_OPTIMIZATION_ENABLE move to 'Build Options' section.