Commit graph

1801 commits

Author SHA1 Message Date
Takeshi ISHII
87199eb2f5
add 'info_config.h' into docs/hardware_keyboard_guidelines.md (#16247)
Added info_config.h added in #10817 to the include order description of config.h.
2022-02-06 17:37:59 +00:00
Jouke Witteveen
14f886d03b
[Docs] Address some typos (also in moonlander matrix.c) (#16248)
* [Docs] Fix repeated words

* [Keyboard] Fix moonlander output

The left/right orientation differs from Ergodox EZ.
2022-02-06 17:36:44 +00:00
Albert Y
7a0b07f84b
[Docs] RGB documentation formatting corrections (#15826) 2022-02-05 21:16:36 -08:00
IskandarMa
10fda3ec8e
[Docs] feature: mouse keys, fix misused wording (#16226) 2022-02-05 11:44:48 +00:00
IskandarMa
f52cc210b8
[Docs] feature_macro.md: minor formatting fix (#16205) 2022-02-05 08:15:21 +11:00
Nick Brassel
1fffcbc298
Revert "[Core] Add Pixel Flow RGB matrix effect (#15829)" (#16209)
This reverts commit e8fa329073.
2022-02-05 05:57:21 +11:00
Albert Y
e8fa329073
[Core] Add Pixel Flow RGB matrix effect (#15829)
* Initial PIXEL FLOW matrix effect commit

* Commit suggested use of rgb_matrix_check_finished_leds

Co-authored-by: Sergey Vlasov <sigprof@gmail.com>

* Code change support for split RGB

Co-authored-by: Sergey Vlasov <sigprof@gmail.com>
2022-02-05 05:55:51 +11:00
Nick Brassel
3403f5813c
Point out that deferred execution needs to be enabled in rules.mk (#16196) 2022-02-04 03:44:51 +00:00
Albert Y
a2ef11bb00
[Docs] Add reference to data sync options for RGB (#16144) 2022-01-31 18:05:09 -08:00
Sergey Vlasov
03b1d9ef1f
Add a warning about USBtinyISP limitations to the ISP flashing guide (#15898) 2022-01-30 11:06:19 -08:00
IskandarMa
d48bff8342
[Docs] zh-cn documentation translate: hand-wire (#15666)
Co-authored-by: peepeetee <43021794+peepeetee@users.noreply.github.com>
Co-authored-by: Dasky <32983009+daskygit@users.noreply.github.com>
2022-01-29 16:06:19 +00:00
IskandarMa
9e79f27547
[Docs] zh-cn document translate: IDE configuration (#15575)
Co-authored-by: peepeetee <43021794+peepeetee@users.noreply.github.com>
Co-authored-by: Dasky <32983009+daskygit@users.noreply.github.com>
2022-01-29 14:27:57 +00:00
Monksoffunk
b2fcc923cb
[Docs] Update Encoder docs about multiple encoders (#16036) 2022-01-28 19:26:42 -08:00
Albert Y
0f0e90971b
[Docs] OLED documentation edits (#15977)
* Clarify OLED_TIMEOUT

* Add a section on logo file location
2022-01-27 15:56:20 +00:00
Nick Brassel
7d6e15423b
Add some clarity regarding new board definitions (#16018) 2022-01-23 22:15:09 +00:00
Albert Y
8901c9eca1
Add Atom editor suggestion (#15969) 2022-01-22 02:48:35 +11:00
Gigahawk
ad09160b03
docs: fix typo in led matrix docs (#15972) 2022-01-21 14:17:19 +00:00
Gigahawk
2baca55cda
docs: fix typo in rgblight docs (#15960) 2022-01-20 23:20:56 +00:00
Petr Viktorin
be06ef6af5
[Docs] Fix typo in ADNS 9800 sensor name (#15956) 2022-01-20 12:14:09 -08:00
IskandarMa
f6a7f4d4ac
update the Chinese translation based on the latest English version (#14924)
Co-authored-by: peepeetee <43021794+peepeetee@users.noreply.github.com>
Co-authored-by: Joy Lee <chang.li@westberrytech.com>
Co-authored-by: LitoMore <LitoMore@users.noreply.github.com>
Co-authored-by: Dasky <32983009+daskygit@users.noreply.github.com>
2022-01-18 18:24:02 +00:00
Ryan
9e92d8a905
Make note of upper limit for UC() (#15870) 2022-01-14 14:47:36 +00:00
Tuk Bredsdorff
8fe320baa6
Fix keymap.json macro example (#15567) 2022-01-13 21:55:48 +00:00
Albert Y
362a65510a
[Docs] Move QMK newbs build environment guide to next section (#15386)
Co-authored-by: Dasky <32983009+daskygit@users.noreply.github.com>
2022-01-13 02:29:13 +00:00
Albert Y
c4b0a06c79
[Docs] Improve Handedness by EEPROM documentation (#15615)
Co-authored-by: Dasky <32983009+daskygit@users.noreply.github.com>
Co-authored-by: filterpaper <filterpaper@localhost>
2022-01-12 14:05:45 -08:00
JayceFayne
93e55605d9
[Docs] fix typo and remove trailing whitespace (#15842) 2022-01-11 17:07:24 -08:00
adlainewson
069ef7eb9e
[Docs] newbs_flashing.md: add link to build environment section (#15654) 2022-01-10 16:54:22 -08:00
Albert Y
8a4fae3b32
[Docs] Recommend the use of RGB matrix functions for code (#15744)
* Recommend the use of functions instead of keycodes

* Commit suggested review

Co-authored-by: Nick Brassel <nick@tzarc.org>

Co-authored-by: Nick Brassel <nick@tzarc.org>
2022-01-11 03:23:28 +11:00
Albert Y
63d3ad155a
[Docs] Recommend the use of RGB light functions for code (#15745)
* Recommend the use of functions instead of keycodes

* Commit suggested revision

Co-authored-by: Nick Brassel <nick@tzarc.org>

Co-authored-by: Nick Brassel <nick@tzarc.org>
2022-01-11 03:23:07 +11:00
Tate
0acc0924db
[Docs] Update feature_tap_dance.md (#14931) 2022-01-08 19:26:44 -08:00
Drashna Jaelre
2669b0bee8
[Docs] Add drag scrolling example to Pointing device docs page (#15715)
Co-authored-by: Dasky <32983009+daskygit@users.noreply.github.com>
2022-01-06 00:30:22 -08:00
Joel Challis
1c1e6fa47d
Remove stale docs translations (#15737) 2022-01-04 18:11:24 -08:00
Albert Y
a88dc08643
[Docs] Note the order of enumerated custom keycodes (#15706)
Co-authored-by: filterpaper <filterpaper@localhost>
2022-01-03 09:07:58 -08:00
Albert Y
6f043c5497
Volume as default encoder documentation example (#15678)
Co-authored-by: filterpaper <filterpaper@localhost>
2022-01-02 00:07:22 -08:00
Albert Y
3dee6e28dd
[Docs] Clarify placement and usage of RGB matrix effect inc files (#15572)
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: filterpaper <filterpaper@localhost>
2021-12-28 13:00:49 -08:00
Albert Y
067d94f0b6
Add layer condition example to encoder callback function (#15490)
Co-authored-by: filterpaper <filterpaper@localhost>
2021-12-27 21:16:19 +11:00
Albert Y
e3073be488
RGB Matrix layer key indicator (#14626)
* Add layer key indicator example

* Update description

* Deobfuscate with index variable

* Add missing layer variable

* Correct color name and indicator function

* Function typo

* Place layer variable outside loops to save firmware space

Co-authored-by: filterpaper <filterpaper@localhost>
2021-12-27 14:16:18 +11:00
Albert Y
b384599663
Link Macro example for COMBO_ACTION documentation (#15164)
* Link Macro example for COMBO_ACTION documentation

* Restructure

Co-authored-by: filterpaper <filterpaper@localhost>
2021-12-27 14:07:00 +11:00
Buttenup
db358d171d
Update feature_macros.md (#15026)
* Update feature_macros.md

Added a link to the usage of SAFE_RANGE as this wasn't clear to me when I visited this page in isolation.

* Fix typo

Co-authored-by: Nick Brassel <nick@tzarc.org>
2021-12-27 13:57:09 +11:00
Scott Chow
1e28667ef8
[Docs] Fixed keycode reference for swirl effect (#15564) 2021-12-24 17:12:33 -08:00
Ian C
435fa2c391
fix typo (#15569) 2021-12-24 20:10:12 +00:00
Thomas Lorblanchès
3f1f60cbf9
doc/faq_debug: qmk cli can also be used to print debug messages (#15528) 2021-12-22 06:27:25 -08:00
Hassan Williamson
8d604e707b
[Docs] Updated typo on feature_bluetooth.md (#15466) 2021-12-13 20:55:53 -08:00
Xelus22
b09c44ced7
[Core] Add configuration of PMW3360 lift off distance (#15424)
* sensor code add

* update documentation

* add default #define

* Update drivers/sensors/pmw3360.c

Co-authored-by: Drashna Jaelre <drashna@live.com>

Co-authored-by: Drashna Jaelre <drashna@live.com>
2021-12-08 23:52:07 -08:00
peepeetee
b2576dcf12
Change "Chinese" to "Simplified Chinese" in langs.md (#15441) 2021-12-09 17:45:24 +11:00
Joel Challis
aecb387692
Add test filter to 'qmk pytest' (#15432)
* Add test filter to 'qmk pytest'

* Bodge for some test filters not resolving qmk

* Update docs
2021-12-09 17:42:11 +11:00
Drashna Jaelre
0df93ec2f9
[Docs] Fix Header formatting in compatible mcu doc (#15438) 2021-12-09 14:49:10 +11:00
Andrew-Fahmy
755731f0ba
Fix RESET not working for keyboards with Kiibohd bootloader (#15430) 2021-12-07 20:36:39 -08:00
thesecretmaster
c2e0b283c3
[Docs] Reorder functions in Understanding QMK (#15357) 2021-11-30 11:24:21 -08:00
Albert Y
d8324e8a9c
Document swap-hands tap-toggle feature (#15229)
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: filterpaper <filterpaper@localhost>
2021-11-29 00:23:37 -08:00
Charly Delay
99ec5e39cf
Fix last merge date (#15327) 2021-11-28 12:59:48 +11:00