summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
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.
2020-01-03Fixed a small typo (#7743)Casper Weiss Bang
2020-01-01[Docs] add japanese translation (faq part) (#7464)umi
* add faq part * add faq part * add faq part * add faq part * add faq part * update for link * update for a punctuation * update files based on comments * restore removed git diff header * correct pathname on git diff header * update files based on comments * update files based on comments * update files based on comments * update files based on comments * update file based on comment * update file based on comment * update file based on comment Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com> Co-Authored-By: shela <shelaf@users.noreply.github.com> Co-Authored-By: satt99 <39004890+satt99@users.noreply.github.com>
2019-12-31SPI DMA based RGB Underglow for STM32 (#7674)Joel Challis
* Initial stash of ws2812 spi driver * Update comment, add sync backup plan * Add testing notes to spi ws2812 driver * Align RGBW error messages
2019-12-31[Docs] Update macOS related issues in docs (#7744)Drashna Jaelre
* [Docs] Update macOS related issues in docs * Update faq_build.md * Apply suggestions from code review Co-Authored-By: fauxpark <fauxpark@gmail.com> Co-authored-by: fauxpark <fauxpark@gmail.com>
2019-12-30[Docs] remove docs/ja/newbs_best_practices.md (#7739)Takeshi ISHII
'docs/ja/newbs_best_practices.md' has been replaced by 'docs/ja/newbs_git_*.md'.
2019-12-28Japanese translation of docs/newbs_git_*.md (#7689)Takeshi ISHII
* update docs/ja/newbs.md * update docs/ja/_summary.md * Translate docs/newbs_git_best_practices.md into Japanese. * Translate docs/newbs_git_using_your_master_branch.md into Japanese. * Translate docs/newbs_git_resolving_merge_conflicts.md into Japanese. * Translate docs/newbs_git_resynchronize_a_branch.md into Japanese. * Update docs/ja/newbs_git_using_your_master_branch.md * Update docs/ja/newbs_git_resynchronize_a_branch.md * Update docs/ja/newbs_git_resynchronize_a_branch.md * Update docs/ja/newbs_git_resynchronize_a_branch.md * Update docs/ja/newbs_git_resynchronize_a_branch.md * Update docs/ja/newbs_git_resynchronize_a_branch.md * update ja/newbs_git_resynchronize_a_branch.md * update ja/newbs_git_resynchronize_a_branch.md * Update docs/ja/newbs_git_best_practices.md * Update docs/ja/_summary.md * Update docs/ja/newbs_git_resynchronize_a_branch.md * update ja/newbs_git_resynchronize_a_branch.md * update ja/newbs_learn_more_resources.md * Update docs/ja/newbs_git_resynchronize_a_branch.md * Update docs/ja/newbs_git_resynchronize_a_branch.md Co-Authored-By: shela <shelaf@users.noreply.github.com>
2019-12-27[Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728)Takeshi ISHII
2019-12-27[Docs] Update Japanese translation (#7693)shela
* [Docs] Update translation * Update docs/ja/contributing.md * Update docs/ja/contributing.md Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
2019-12-27Fix file encoding for zh-cn/custom_quantum_functions.md (#7665)fauxpark
2019-12-21[Docs] fix docs (#7642)shela
* [Docs] recurse-submodules option is need now * [Docs] `tmk_core` folder is correct * [Docs] fix typo * [Docs] package scope has changed * [Docs] Fix menu differences * Update docs/arm_debugging.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/arm_debugging.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * fix typo Co-authored-by: fauxpark <fauxpark@gmail.com>
2019-12-18Improve docs "Edit Document" footerfauxpark
2019-12-16[Docs] add japanese translation (basic part) (#7461)umi
* add basic part * update cli * update cli * correct links to ja document * update files based on comments * update for a postpositional particle * update for a punctuation * update files based on comments * update files based on comments * update files based on comments * update files based on comments * update files based on comments * update files based on comments * update files based on comments Co-Authored-By: shela <shelaf@users.noreply.github.com> Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
2019-12-16Merge pull request #7276 from zvecr/feature/backlight_driver_configJoel Challis
Convert backlight to follow driver rules pattern
2019-12-14Change newbs.md to link to the new newbs_git_best_practices.md instead of ↵Takeshi ISHII
newbs_best_practices.md. (#7633)
2019-12-14Convert backlight to follow driver rules pattern - update docszvecr
2019-12-12[Docs] update git command and directory name of documents (#7619)umi
2019-12-11Remove mbed files (#7605)Joel Challis
* Remove mbed files * Remove mbed files - fix comment * Remove mbed logic blocks
2019-12-11[Docs] Remove some outdated FAQ items (#7607)fauxpark
2019-12-11Use `clock_prescale_set()` from avr-libc (#7540)fauxpark
* Use `clock_prescale_set()` from avr-libc * Remove outdated FAQ info
2019-12-10Update feature support for Proton C (#7596)Duncan Elliot
Added a couple of entries for some features not currently supported on Proton C.
2019-12-10[Docs] Fix docs fallback for pt-br (#7602)fauxpark
2019-12-10[Docs] add README translation in portuguese (#7016)Igor Hideki Trindade
* add README translation in portuguese * add lang in menu * Update docs/pt-br/README.md * Update docs/pt-br/README.md * Update docs/pt-br/README.md * Update docs/pt-br/README.md * Update docs/pt-br/README.md * Update docs/pt-br/README.md * Update docs/pt-br/README.md * Update docs/pt-br/_summary.md * Update sumary links * Update README Co-Authored-By: Álvaro A. Volpato <alvaro.volpato@usp.br>
2019-12-08fix instructions for oneshot layer handling on key release (#7554)hmkemppainen
* fix instructions for oneshot layer handling on key release * use ONESHOT_OTHER_KEY_PRESSED instead of ONESHOT_PRESSED Co-Authored-By: Drashna Jaelre <drashna@live.com>
2019-12-08Improve support and docs for ADC driver (#7191)fauxpark
* Improve support and docs for ADC driver * Comment ADC channels * Move to Makers and Modders section, and fix usage instructions * Flesh out intro * Superscript 328P note * Fix pin_to_mux LUT * Support USB64/1287 as well * analogReadPin() defaults to 0V mux on invalid pin * Update pinToMux() function documentation * Dot * Accept (some of) the `qmk cformat` changes * Do clang-format properly * More wording tweaks * Link to encoder docs
2019-12-07Minor grammar and filename fixes in docs (#7559)osjuga
Grammar in coding_conventions_c.md and coding_conventions_python.md `rule.mk` to `rules.mk` in feature_haptic_feedback.md and feature_rgb_matrix.md
2019-12-06[Docs] Creating RU version of getting_started_introduction (#7224)Gregory Gubarev
* Creating RU version of getting_started_introduction * Update docs/ru-ru/getting_started_introduction.md Update "предполагается" * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md Co-Authored-By: Nikita Titov <nekit94-08@mail.ru>
2019-12-06[Docs] Create RU ver of becoming_a_qmk_collaborator (#7226)Gregory Gubarev
* Create RU ver of becoming_a_qmk_collaborator * Updated * Updated - collaborator to соавтор * Update docs/ru-ru/becoming_a_qmk_collaborator.md * Update docs/ru-ru/becoming_a_qmk_collaborator.md * Update docs/ru-ru/becoming_a_qmk_collaborator.md * Update docs/ru-ru/becoming_a_qmk_collaborator.md * Update docs/ru-ru/becoming_a_qmk_collaborator.md * Update docs/ru-ru/becoming_a_qmk_collaborator.md * Update docs/ru-ru/becoming_a_qmk_collaborator.md Co-Authored-By: Nikita Titov <nekit94-08@mail.ru>
2019-12-06Update getting_started_make_guide.md (#7538)arlenk
* Update getting_started_make_guide.md clarifying that NO_PRINT and USER_PRINT should not be used at the same time. * Update docs/getting_started_make_guide.md Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-02 22:09:33 +0000