Commit Graph

824 Commits

Author SHA1 Message Date
ridingqwerty 95c24bbaf8
Implement and document TAPPING_FORCE_HOLD_PER_KEY (#7859)
* 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-17 15:49:23 -05:00
skullY 58d27cf404 Add a note explaining how to run tests 2020-01-14 07:52:14 -08:00
skullY 44168baaa7 Add a section on python tests 2020-01-14 07:52:14 -08:00
fauxpark c7b2d60a23 Move Space Cadet keycodes to their own section in keycode reference (#7889) 2020-01-14 14:02:13 +00:00
zk-phi 7f388b6553 Add per-key IGNORE_MOD_TAP_INTERRUPT feature (#7838)
* 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-10 02:48:06 -05:00
shela 5a02cc00a4 Fix docker script and document (#7786)
Fixed error when keyboard parameter is omitted in interactive mode.
2020-01-10 00:44:16 +00:00
James Young 71de09d751 Update Breaking Changes doc timeline 2020-01-09 11:19:47 -08:00
Rob Haswell cf30c5d17f RGB matrix effect - left-right gradient (#7742)
* 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-07 21:25:17 +00:00
Takeshi ISHII b3b115bcc4 [Docs] Update check commands in Japanese documents (#7787)
The Japanese documents included a sample command to check the original document changes. But there was something wrong, so I fixed it.
2020-01-05 23:43:11 -08:00
James Young c1feeaa57f
Update Breaking Changes doc for 2020-02-29 merge 2020-01-04 12:24:51 -08:00
shela 6e520a721d [Docs] fix installation commands for macos (#7785)
* [Docs] fix installation commands for macos

* Update docs/getting_started_build_tools.md
2020-01-03 22:57:59 -08:00
shela 8b80cf853b [Docs] Update Japanese translation (#7783)
* [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-03 22:57:03 -08:00
Takeshi ISHII 3fd8f160c3 [Docs] Added description of LIB_SRC to docs/config_options.md (#7765)
And LINK_TIME_OPTIMIZATION_ENABLE move to 'Build Options' section.
2020-01-02 14:47:27 -08:00
Casper Weiss Bang dd04079098 Fixed a small typo (#7743) 2020-01-03 08:06:46 +11:00
umi 91013d452f [Docs] add japanese translation (faq part) (#7464)
* 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>
2020-01-01 18:06:55 -08:00
Joel Challis 680ebef086
SPI DMA based RGB Underglow for STM32 (#7674)
* 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 17:26:40 +00:00
Drashna Jaelre a52e55ec09 [Docs] Update macOS related issues in docs (#7744)
* [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-31 14:33:54 +00:00
Takeshi ISHII d1ed98f58b [Docs] remove docs/ja/newbs_best_practices.md (#7739)
'docs/ja/newbs_best_practices.md' has been replaced by 'docs/ja/newbs_git_*.md'.
2019-12-30 09:15:23 -08:00
Takeshi ISHII 25aaeb4f40 Japanese translation of docs/newbs_git_*.md (#7689)
* 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-28 23:38:33 -08:00
Takeshi ISHII 26a823082b [Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728) 2019-12-27 14:31:23 -08:00
shela 80e73b6210 [Docs] Update Japanese translation (#7693)
* [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-27 12:09:32 -08:00
fauxpark b359830ea2 Fix file encoding for zh-cn/custom_quantum_functions.md (#7665) 2019-12-27 03:31:48 +00:00
shela 52c18ef026 [Docs] fix docs (#7642)
* [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-21 11:00:22 +00:00
fauxpark 3c190f8927 Improve docs "Edit Document" footer 2019-12-18 14:01:13 +11:00
umi a860da8914 [Docs] add japanese translation (basic part) (#7461)
* 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-16 21:01:46 -08:00
Joel Challis adb72b60b0
Merge pull request #7276 from zvecr/feature/backlight_driver_config
Convert backlight to follow driver rules pattern
2019-12-16 16:39:54 +00:00
Takeshi ISHII b54722cc63 Change newbs.md to link to the new newbs_git_best_practices.md instead of newbs_best_practices.md. (#7633) 2019-12-14 18:16:31 +00:00
zvecr 3d54b1adf0 Convert backlight to follow driver rules pattern - update docs 2019-12-14 03:25:06 +00:00
umi 09c7304bd9 [Docs] update git command and directory name of documents (#7619) 2019-12-12 20:59:00 -08:00
Joel Challis 071eb2478f Remove mbed files (#7605)
* Remove mbed files

* Remove mbed files - fix comment

* Remove mbed logic blocks
2019-12-11 11:36:00 -08:00
fauxpark 770a4ee729 [Docs] Remove some outdated FAQ items (#7607) 2019-12-11 11:33:09 -08:00
fauxpark 698d0dbda8 Use `clock_prescale_set()` from avr-libc (#7540)
* Use `clock_prescale_set()` from avr-libc

* Remove outdated FAQ info
2019-12-11 01:26:40 +00:00
Duncan Elliot 1af31a0523 Update feature support for Proton C (#7596)
Added a couple of entries for some features not currently supported on Proton C.
2019-12-10 18:31:39 -05:00
fauxpark a8153774b5 [Docs] Fix docs fallback for pt-br (#7602) 2019-12-10 14:27:40 -08:00
Igor Hideki Trindade 10e8ed7430 [Docs] add README translation in portuguese (#7016)
* 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-10 10:19:12 -08:00
hmkemppainen e676278474 fix instructions for oneshot layer handling on key release (#7554)
* 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-08 02:18:05 +00:00
fauxpark a8320f20f7
Improve support and docs for ADC driver (#7191)
* 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-08 12:11:29 +11:00
osjuga f275ffbdfc Minor grammar and filename fixes in docs (#7559)
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-07 23:19:18 +11:00
Gregory Gubarev e8efc46e74 [Docs] Creating RU version of getting_started_introduction (#7224)
* 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 11:25:05 -08:00
Gregory Gubarev 1b08a19e3e [Docs] Create RU ver of becoming_a_qmk_collaborator (#7226)
* 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-06 11:16:00 -08:00
arlenk 380e05ad6e Update getting_started_make_guide.md (#7538)
* 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>
2019-12-06 19:42:33 +11:00
fauxpark 3ad389de55 Add short aliases for Magic keycodes (#7541)
* Add short alias for `MAGIC_TOGGLE_NKRO`

* Add aliases for the other Bootmagic keycodes

* Replace long form in default keymaps
2019-12-05 00:44:39 -08:00
James Young 3152bf572b
[Docs] Restructure of Git Best Practices doc (#7231)
* Add "Resynchronizing an Out-of-Sync Git Branch" doc

* Update (Git) Best Practices doc title and filename

* Rename Branch Resync doc

* fork Best Practices doc into multiple files

* Add the doc list to Git Best Practices doc

* Update sidebar

* Update internal references

* Update sidebar - add subsection

* Update Your Fork's Master page title

* title case on Git Best Practices main doc

* ... and in the Resynchronizing a Branch doc

* Please read Part 1

I worked really hard on this, okay?

* Please use branches, too.

* suggestions by mtei

* change note about adding multiple files

* note that the name given the remote repo is arbitrary

* suggestions by fauxpark

* Git Best Practices -> Best Git Practices

Reads more naturally.

* rephrase hint block regarding remote name

* rework the resynchronization instructions per mtei

* use hint boxes for reference to Part 1 doc

I may be addicted to hint boxes. I'm sorry fauxpark. 😢

* add some clarity about the upstream repo

* wordsmithing per mtei

* restyle the shell code blocks

Makes them more consistent to the other docs in this section.
2019-12-02 18:47:02 -08:00
umi da1a527c90 [Docs] add japanese translations (#7454)
* for initial commit

* for initial commit

* for initial commit

* Update led_update_kb example (#7451)

* Update led_update_kb example

* Update comment to explain pin behavior

* wordsmith

* wordsmithing 2

* Remove CR when computing BOOTLOADER_SIZE. (#7453)

* Set up language fallback for docs, and update translation guidelines (#7403)

* Set up language fallback for docs, and update translation guidelines

* Title Case

* Add ID example

* Link to emoji flag cheatsheet

* Move docs preview section to contributing.md

* Point to docs preview in the readme

* [Keyboard] Added Cans12er keyboard (#7455)

* added cans12er keyboard

* updated readme

Updated the readme to conform with the provided template from the qmk_firmware githubpage

* Update keyboards/cans12er/README.md

Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com>

* Changed configuration

Changed the configuration based on the Change Request from PR #7455 made by github user noroadsleft

* [Keyboard] Update ATmega32A readme files to match template (#7462)

* Update atmega32a readme files to match template

* Update atmega32a readme files to match template - fixes

* Apply suggestions from code review

* 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: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
Co-Authored-By: shela <shelaf@users.noreply.github.com>
2019-12-02 11:12:02 -08:00
fauxpark f099142004 Add _summary.md for Russian docs with proper language prefix (#7514) 2019-11-30 13:01:41 +00:00
fauxpark 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 2019-11-28 22:14:04 +00:00
Manna Harbour f9521ffa21 Add shift-to-invert to remaining directional RGB_* keycode pairs (#7484)
* Add shift-to-invert to remaining directional RGB_* keycode pairs

RGB_MODE_FORWARD / RGB_MODE_REVERSE invert their functions when shift is held.
This change adds the same capabilities to the remaining directional RGB_*
keycode pairs.  This improves consistency and provides full RGB control in a
keymap containing only one keycode from each pair.

* remove redundant variable

* fix typo

* Fix more typos

Flyspell is on now I swear!
2019-11-28 22:00:29 +00:00
Joel Challis 235da6973d
Install bootloadHid as part of qmk_install (#7463)
* Install bootloadHid on macos

* Install bootloadHid on windows

* Highlight bootloadHID is now installed in docs

* Update udev rules for bootloadHID

* Install bootloadHid on some distros

* fix caterina udev filename
2019-11-28 15:29:11 +00:00
fauxpark 170261328e
Add language prefixes to docs sidebar entries and readmes (#7406)
* Add language prefixes to docs sidebar entries and readmes

* Remove prefix where it doesn't belong
2019-11-26 18:22:13 +11:00
fauxpark 5a6737a778 Send string keycode tweaks (#7471) 2019-11-25 23:16:58 -08:00