Commit graph

1366 commits

Author SHA1 Message Date
shela
28c78023c5
[Docs] Update Japanese translation of newbs_building_firmware.md. (#9810)
* Update Japanese translation of newbs_building_firmware.md.

* fix original document version.

* Apply suggestions from code review
2020-07-31 17:57:31 -07:00
umi
ea3f74874f
[Docs] Japanese translation of docs/other_vscode.md (#9756)
* add other_vscode.md translation

* update based on comment

* update based on comment

* update based on comment
2020-07-31 17:49:25 -07:00
shela
a88e690351
[Docs] Update Japanese translation of keymap.md. (#9807)
* Update Japanese translation of keymap.md.

* fix original document version.

* Apply suggestions from code review

* Update translation
2020-07-31 17:25:20 -07:00
shela
0f3e933db9
[Docs] Update Japanese translation of feature_backlight.md. (#9803)
* Update Japanese translation of feature_backlight.md.

* fix original document version.

* Apply suggestions from code review
2020-07-31 16:28:29 -07:00
Rustam Zagirov
5bd239e1c0
Remove unnecessary break after return from documentation (#9892) 2020-07-31 15:58:55 +01:00
shela
3c7fc3c82e
[Docs] Update Japanese translation of feature_tap_dance.md. (#9808)
* Update Japanese translation of feature_tap_dance.md.

* fix original document version.

* Update docs/ja/feature_tap_dance.md
2020-07-30 22:31:34 -07:00
shela
06cf6982bb
[Docs] Update Japanese translation of feature_ps2_mouse.md. (#9815) 2020-07-30 16:10:44 -07:00
shela
1ca7dcb0b2
[Docs] Update Japanese translation of feature_mouse_keys.md. (#9809)
* Update Japanese translation of feature_mouse_keys.md.

* fix original document version.

* Update docs/ja/feature_mouse_keys.md

* update based on comment
2020-07-30 15:22:22 -07:00
shela
9758bcb28b
[Docs] Update Japanese translation of feature_macros.md. (#9767)
* Update Japanese translation of feature_macros.md.

* Update feature_macros.md

fix original document version.
2020-07-30 00:35:45 -07:00
umi
bf05f773bd
[Docs] Japanese translation of docs/internals_gpio_control.md (#9751)
* add internals_gpio_control.md translation

* update based on comment

* update based on comment

* update based on comment
2020-07-29 19:44:23 -07:00
umi
de7da0b48f
[Docs] Japanese translation of docs/other_eclipse.md (#9755)
* add other_eclipse.md translation

* update based on comment

* update based on comment
2020-07-29 17:01:34 -07:00
umi
ea1c7f1856
[Docs] Japanese translation of docs/one_shot_keys.md (#9754)
* add one_shot_keys.md translation

* update based on comment

* update based on comment
2020-07-29 19:02:37 +09:00
umi
a57b313153
[Docs] Japanese translation of docs/mod_tap.md (#9753)
* add mod_tap.md translation

* update based on comment

* update based on comment
2020-07-29 19:01:42 +09:00
umi
7ff85e241b
[Docs] Japanese translation of docs/how_keyboards_work.md (#9683)
* add how_keyboards_work.md translation

* update based on comment

* update based on comment

* update based on comment
2020-07-29 19:00:26 +09:00
umi
7c7a2be4b0
[Docs] Japanese translation of docs/how_a_matrix_works.md (#9682)
* add how_a_matrix_works.md translation

* update based on comment

* update based on comment
2020-07-29 18:59:44 +09:00
umi
463c97f4c6
[Docs] Japanese translation of docs/feature_stenography.md (#9525)
* add feature_stenography.md translation

* update based on comment

* Update docs/ja/feature_stenography.md

Co-authored-by: shela <shelaf@users.noreply.github.com>

* Update docs/ja/feature_stenography.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-07-27 20:31:19 +09:00
shela
f5c2cd2eb7
[Docs] Update Japanese translation of custom_quantum_functions.md. (#9760)
* Update Japanese translation of custom_quantum_functions.md.

* Update custom_quantum_functions.md

fix original document version.
2020-07-25 09:36:48 +09:00
umi
0e30266711
[Docs] Japanese translation of docs/getting_started_docker.md (#9681)
* add getting_started_docker.md translation

* fix some typo

* update based on comment
2020-07-25 09:34:07 +09:00
umi
656a8327f4
[Docs] Japanese translation of docs/flashing_bootloadhid.md (#9680)
* add flashing_bootloadhid.md translation

* update based on comment
2020-07-25 09:33:20 +09:00
Takeshi ISHII
1fed91f272
Japanese documents 'original document' comment fix (#9816) 2020-07-25 08:38:13 +09:00
shela
7675e80f5c
[Docs] Update Japanese translation of feature_pointing_device.md. (#9771)
* Update Japanese translation of feature_pointing_device.md.

* Update docs/ja/feature_pointing_device.md

* Update feature_pointing_device.md

fix original document version.
2020-07-24 11:19:46 -07:00
shela
2b960b8bd7
[Docs] Update Japanese translation of feature_userspace.md. (#9775) 2020-07-24 02:49:36 -07:00
shela
955047dd7d
[Docs] Update Japanese translation of feature_hd44780.md. (#9766) 2020-07-24 01:54:34 -07:00
shela
0a5997b0af
[Docs] Update Japanese translation of faq_build.md. (#9762) 2020-07-24 01:45:30 -07:00
shela
e85ec9a09a
Update Japanese translation of _summary.md. (#9777) 2020-07-23 17:34:42 +09:00
shela
562b853a8f
[Docs] Update Japanese translation of feature_split_keyboard.md. (#9780)
* Update Japanese translation of feature_split_keyboard.md.

* Update docs/ja/feature_split_keyboard.md

Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com>

Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
2020-07-23 17:32:57 +09:00
shela
69abe5b405
Update Japanese translation of feature_layers.md. (#9769) 2020-07-23 17:30:59 +09:00
shela
a9cb3835ca
Update Japanese translation of feature_encoders.md. (#9765) 2020-07-23 17:29:02 +09:00
shela
e1f1e1582e
Update Japanese translation of feature_dynamic_macros.md. (#9764) 2020-07-23 17:27:40 +09:00
shela
65f803a1de
Update Japanese translation of feature_dip_switch.md. (#9763) 2020-07-23 17:26:12 +09:00
shela
706f1b433c
Update Japanese translation of driver_installation_zadig.md. (#9761) 2020-07-23 17:23:56 +09:00
shela
841a2721bc
Update Japanese translation of config_options.md. (#9759) 2020-07-23 17:22:10 +09:00
umi
3f0292d726
[Docs] Japanese translation of docs/cli_development.md (#9699)
* add cli_development.md translation

* update based on comment

* update based on comment

* update based on comment
2020-07-22 11:06:27 +09:00
shela
58c31f5632
fixed alt text for images. (#9781) 2020-07-22 01:30:33 +09:00
nathanvercaemert
19006c9753
Implemented New MK_COMBINED Functionality (#9557)
* implemented new mousekey_combined functionality

* minor formatting change to documentation

* Update tmk_core/common/mousekey.c

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update tmk_core/common/mousekey.c

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update tmk_core/common/mousekey.c

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update tmk_core/common/mousekey.c

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update docs/feature_mouse_keys.md

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

* Update docs/feature_mouse_keys.md

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

* Update docs/feature_mouse_keys.md

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

* Update docs/feature_mouse_keys.md

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

Co-authored-by: Nathan Vercaemert <nathan.vercaemert@gmail.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Nick Brassel <nick@tzarc.org>
2020-07-21 09:28:38 +10:00
Drashna Jaelre
c4d778a302
[Docs] Update ISP Guide (#9748)
* [Doc] Update ISP Guide

Correct the fuses for Caterina, and make the `:production` command more obvious.

* fix casing before fauxpark catches it
2020-07-18 21:24:23 +01:00
umi
82dcb17338
[Docs] Japanese translation of docs/feature_debounce_type.md (#9524)
* add feature_debounce_type.md translation

* update based on comment

* update based on comment
2020-07-18 01:47:12 -07:00
Ryan
19b70b2737
MSYS2: Switch to bootloadHID package and bring back avrdude package (#9736)
* MSYS2: Switch to bootloadHID package and bring back avrdude package

* Update Zadig docs as well
2020-07-16 18:01:34 +01:00
Konstantin Đorđević
61b64bb82a
Redefine IS_LAYER_ON/OFF() as aliases for existing layer functions (#6352)
* Add IS_LAYER_ON_STATE()/IS_LAYER_OFF_STATE() macros

* Add docs for IS_LAYER_ON/OFF(_STATE) macros

* Remove IS_LAYER_ON/OFF_STATE redefinition in userspace

* Run clang-format on quantum/quantum.h

* Redefine IS_LAYER_ON/OFF(_STATE) as aliases of existing layer functions

Also update relevant doc entries.

Needs testing to check if this breaks existing IS_LAYER_ON/OFF usage in certain
edge cases (namely calling the macros with 0).

* Reformat layer check function docs
2020-07-16 22:27:55 +10:00
Ryan
72d3270547
Remove DESCRIPTION (#9732) 2020-07-16 15:49:18 +10:00
Gautham Yerroju
92d0a71af7
OLED driver function to set pixels (#9713)
* Add a function to set individual pixels

* Add documentation for oled_write_pixel

* use smaller data type for oled_write_pixel

* Fix boundary check edge case

* Update oled_write_pixel doc

Co-authored-by: Ryan <fauxpark@gmail.com>

Co-authored-by: Ryan <fauxpark@gmail.com>
2020-07-16 15:48:04 +10:00
umi
1b96038115
[Docs] Japanese translation of docs/coding_conventions_python.md (#9517)
* add coding_conventions_python.md translation

* update based on comment

* update based on comment
2020-07-12 11:43:43 +09:00
shela
64603ab647
fix typo (#9695) 2020-07-11 23:06:33 +10:00
umi
bae3e03e5f
[Docs] Japanese translation of docs/coding_conventions_c.md (#9516)
* add coding_conventions_c.md translation

* update based on comment

* update based on comment

* update based on comment
2020-07-09 21:13:32 +09:00
Guillaume Gérard
5f9fb01020
[Keymap Extra] Add French AZERTY (AFNOR - NF Z71-300) (#9644)
Co-authored-by: Ryan <fauxpark@gmail.com>
2020-07-08 19:55:02 +01:00
Matthew Tse
038a86a9b8
Add missing bracket for Tap-Hold code sample (#9675)
The `TAPPING_TERM_PER_KEY` code sample is missing a closing bracket.
This adds it.
2020-07-08 13:40:13 +10:00
Dongfeng Yu
666cb44673
Allowing Pressing the Start Buttons Again to Stop Dynamic Macro Recording (#9446) 2020-07-07 21:59:13 +01:00
Erovia
e6bcc232ed
Docs: update ModemManager recommendation (#9328)
Instead of modifying the service file provided by the distro,
use drop-in functionaly to explicitly specify the policy.
2020-07-07 19:22:38 +01:00
yanekm
29ebb99b1f
fixed link to Eclipse instructions (#9647) 2020-07-05 08:50:01 +10:00
Takeshi ISHII
c2ca57c8f4
add DIP_SWITCH_MATRIX_GRID support (#8772)
* dipsw test on helix/rev2/sc/back:five_rows

* add peek_matrix() to matrix_common.c

* add DIP_SWITCH_MATRIX_GRID support to quantum/dip_switch.c

* update docs/feature_dip_switch.md about DIP_SWITCH_MATRIX_GRID

* Test end. remove test code. Revert "dipsw test on helix/rev2/sc/back:five_rows"

This reverts commit 6d4304c74557597c9fb4d324f79c3ae4793ae874.
2020-07-04 23:20:49 +09:00
Takeshi ISHII
5c8b23ccff
add SPLIT_HAND_MATRIX_GRID support (#8685)
Co-authored-by: Danny <nooges@users.noreply.github.com>
2020-07-04 15:04:47 +01:00
Ryan
2c98c4dd4e
Backlight docs wordsmithing (#9631) 2020-07-03 10:05:59 +01:00
Manna Harbour
b7dc2eb9ab
Add movement hook to ps2_mouse (#8805)
Process mouse movement in the keymap before it is sent to the host. Example uses
include filtering noise, adding acceleration, and automatically activating a
layer. To use, define the following function in your keymap:

void ps2_mouse_moved_user(report_mouse_t *mouse_report);
2020-07-02 21:54:15 +01:00
umi
4e4a3449a7
[Docs] Japanese translation of docs/compatible_microcontrollers.md (#9518)
* add compatible_microcontrollers.md translation

* update based on comment

* update based on comment
2020-06-29 00:30:16 -07:00
Takeshi ISHII
e184da91a6
[Update] Japanese translation of docs/cli.md and docs/cli_commands.md (#9536)
* update docs/ja/cli.md

* update docs/ja/cli_commands.md

* Update docs/ja/cli.md

Co-authored-by: shela <shelaf@users.noreply.github.com>

* update docs/ja/cli_commands.md

Co-authored-by: shela <shelaf@users.noreply.github.com>
2020-06-28 20:27:06 +09:00
umi
097df6afdb
[Docs] Japanese translation of docs/documentation_templates.md (#9523)
* add documentation_templates.md translation

* update based on comment

* update based on comment
2020-06-27 20:02:43 -07:00
umi
6574ac52ad
[Docs] Japanese translation of docs/documentation_best_practices.md (#9522)
* add documentation_best_practices.md translation

* update based on comment

* update based on comment
2020-06-27 20:00:55 -07:00
shela
995464cb9c
[Docs] fix file path (#9540) 2020-06-25 15:58:36 +10:00
Guillaume Gérard
9b85bd68a4
feat: add dvorak-fr as extra keymap (#9512) 2020-06-24 22:52:40 -07:00
Takeshi ISHII
ce91b36c5d
[Update] Japanese Translation of docs/feature_layers.md (#9537)
* update docs/ja/feature_layers.md

see https://github.com/qmk/qmk_firmware/pull/9492

* update original document's TAG
2020-06-25 14:22:17 +09:00
Takeshi ISHII
a4b2baa2ba
[Update] Japanese translation of docs/newbs_building_firmware_configurator.md (#9395)
* update docs/ja/newbs_building_firmware_configurator.md

Following the original changes, docs/ja/newbs_building_firmware_configurator.md  was divided into docs/ja/configurator_step_by_step.md and docs/ja/configurator_troubleshooting.md.

* Update docs/ja/configurator_step_by_step.md

Co-authored-by: shela <shelaf@users.noreply.github.com>

* Update docs/ja/configurator_step_by_step.md

Co-authored-by: shela <shelaf@users.noreply.github.com>

* Update docs/ja/configurator_step_by_step.md

Co-authored-by: shela <shelaf@users.noreply.github.com>

* Update docs/ja/configurator_step_by_step.md

Co-authored-by: shela <shelaf@users.noreply.github.com>

* Update docs/ja/configurator_step_by_step.md

Co-authored-by: shela <shelaf@users.noreply.github.com>

* Update docs/ja/configurator_troubleshooting.md

Co-authored-by: shela <shelaf@users.noreply.github.com>

* Update docs/ja/configurator_troubleshooting.md

Co-authored-by: shela <shelaf@users.noreply.github.com>

* Update docs/ja/configurator_step_by_step.md

Co-authored-by: shela <shelaf@users.noreply.github.com>

* Update docs/ja/configurator_step_by_step.md

Co-authored-by: shela <shelaf@users.noreply.github.com>

* Update docs/ja/configurator_step_by_step.md

Co-authored-by: shela <shelaf@users.noreply.github.com>

* Update docs/ja/configurator_troubleshooting.md

Co-authored-by: shela <shelaf@users.noreply.github.com>

* Update docs/ja/newbs_building_firmware_configurator.md

Co-authored-by: shela <shelaf@users.noreply.github.com>

* Update docs/ja/configurator_troubleshooting.md

Co-authored-by: shela <shelaf@users.noreply.github.com>

* Update docs/ja/newbs_building_firmware_configurator.md

Co-authored-by: shela <shelaf@users.noreply.github.com>

* Update docs/ja/configurator_step_by_step.md

Co-authored-by: shela <shelaf@users.noreply.github.com>

Co-authored-by: shela <shelaf@users.noreply.github.com>
2020-06-24 18:10:52 +09:00
Joshua Diamond
4b80ee46f8
Add Hebrew keymap aliases (#9383)
* Add Hebrew keymap aliases

* Use NBSP for internal space in box drawings

* Apply suggestions from code review

* More whitespace fixes

* IL_DVAV, IL_DYOD and IL_VYOD were incorrect

* Add IL_DEG, IL_MUL, IL_DIV

* Hebrew is now ISO (no more BAE)

* Use ISO left shift

* Apply suggestions from code review

* DYOD and VYOD were reversed in diagram.

Oops!
2020-06-23 22:35:43 -07:00
umi
b3b617633c
[Docs] Japanese translation of docs/feature_layers.md (#9252)
* add feature_layers.md translation

* update based on comment

* update based on comment

* update based on comment
2020-06-23 16:42:01 +09:00
shela
9ae8a45197
fixed the layer limit of LT() (#9492) 2020-06-23 16:24:23 +09:00
Takeshi ISHII
1ab8f969f6
[Update] Japanese Translation of docs/faq_build.md (#9458)
* update docs/ja/faq_build.md

* update docs/ja/faq_build.md to 0.9.10

* Update docs/ja/faq_build.md

Co-authored-by: shela <shelaf@users.noreply.github.com>

Co-authored-by: shela <shelaf@users.noreply.github.com>
2020-06-22 20:24:33 +09:00
Takeshi ISHII
58af0305f5
[Update] Japanese translation of newbs.md (#9388)
* update docs/ja/newbs.md

* Update docs/ja/newbs.md

Co-authored-by: shela <shelaf@users.noreply.github.com>

* Update docs/ja/newbs.md

Co-authored-by: shela <shelaf@users.noreply.github.com>

* Update docs/ja/newbs.md

Co-authored-by: shela <shelaf@users.noreply.github.com>

Co-authored-by: shela <shelaf@users.noreply.github.com>
2020-06-22 20:13:01 +09:00
umi
c7cc20918b
[Docs] Japanese translation of docs/feature_userspace.md (#9253)
* add feature_userspace.md translation

* update based on comment
2020-06-22 20:11:49 +09:00
umi
924573ece2
[Docs] Japanese translation of docs/feature_macros.md (#9137)
* add feature_macros.md translation

* update based on comment

* update based on comment
2020-06-22 20:08:26 +09:00
Drashna Jaelre
98642ca028
Improve keycode handling for RGB (#7677)
Co-authored-by: drashna <drashna@live.com>
Co-authored-by: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
2020-06-22 09:38:58 +01:00
shela
e79fb2c26e
[Docs] fix indentation (#9491) 2020-06-21 20:03:35 +01:00
Takeshi ISHII
3e0f8f9c8b
update docs/ja/feature_bootmagic.md (#9459) 2020-06-21 21:56:06 +09:00
Takeshi ISHII
b0a31f0bf3
update ja/hardware_keyboard_guidelines.md (#9457) 2020-06-21 21:49:43 +09:00
Takeshi ISHII
a91034b802
[Update] Change Original TAGs of Japanese translations (#9453)
* The TAGs of the original document has been updated to facilitate future verification.

 * docs/ja/driver_installation_zadig.md
 * docs/ja/feature_audio.md
 * docs/ja/feature_auto_shift.md
 * docs/ja/feature_bluetooth.md
 * docs/ja/hardware_avr.md
 * docs/ja/hardware_drivers.md
 * docs/ja/getting_started_make_guide.md

* The TAG of the original document has been updated to facilitate future verification.

* The TAG of the original document has been updated to facilitate future verification.

* update docs/ja/feature_tap_dance.md
2020-06-21 21:45:27 +09:00
Takeshi ISHII
2f85f6fbff
[Docs] Japanese translation of breaking_changes*.md (#8576)
* add japanese translation 'docs/ja/breaking_changes.md'

Note: this is cherry-pick from umi-umi's translation in PR #7248

* update ja/breaking_changes.md

* update ja/breaking_changes.md, add ja/breaking_changes_instructions.md

* translating ja/breaking_changes_instructions.md

* translating ja/breaking_changes_instructions.md

* translated ja/breaking_changes_instructions.md

* update ja/breaking_changes.md, ja/breaking_changes_instructions.md

Breaking change の訳語を「破壊的な変更」から「互換性を破る変更」に変更。
ただし、文中の用語としては、Breaking change をそのまま使用するむねドキュメントの導入部で
訳注でしめし、文中では、原語のまま使用する。

* update docs/ja/_summary.md

* Update docs/ja/breaking_changes.md

Co-Authored-By: shela <shelaf@users.noreply.github.com>

* Update docs/ja/breaking_changes.md

Co-Authored-By: shela <shelaf@users.noreply.github.com>

* Update docs/ja/breaking_changes.md

Co-Authored-By: shela <shelaf@users.noreply.github.com>

* Update docs/ja/breaking_changes.md

Co-Authored-By: shela <shelaf@users.noreply.github.com>

* Update docs/ja/breaking_changes.md

Co-Authored-By: shela <shelaf@users.noreply.github.com>

* Update docs/ja/breaking_changes.md

Co-Authored-By: shela <shelaf@users.noreply.github.com>

* Update docs/ja/breaking_changes.md

* update docs/ja/breaking_changes.md

* update docs/ja/breaking_changes.md

* update docs/ja/breaking_changes.md

* update docs/ja/breaking_changes.md

* update docs/ja/breaking_changes.md

* Update docs/ja/breaking_changes_instructions.md

Co-Authored-By: shela <shelaf@users.noreply.github.com>

* Update docs/ja/breaking_changes_instructions.md

Co-Authored-By: shela <shelaf@users.noreply.github.com>

* update docs/ja/breaking_changes.md

* Update docs/ja/breaking_changes_instructions.md

Co-Authored-By: shela <shelaf@users.noreply.github.com>

* Update docs/ja/breaking_changes_instructions.md

* Update docs/ja/breaking_changes_instructions.md

Co-Authored-By: shela <shelaf@users.noreply.github.com>

* update docs/ja/breaking_changes_instructions.md

* update docs/ja/breaking_changes_instructions.md

* The base of the translation of docs/ja/breaking_changes_instructions.md was changed to 0.9.0.

* The base of the translation of docs/ja/breaking_changes.md was changed to 0.9.0.

* Update docs/ja/breaking_changes.md

Co-authored-by: s-show <s1shimz@gmail.com>

* update docs/ja/breaking_changes.md

* Update docs/ja/breaking_changes_instructions.md

Co-authored-by: shela <shelaf@users.noreply.github.com>

* update docs/ja/breaking_changes.md

* update docs/ja/breaking_changes.md

Co-authored-by: umi-umi <57262844+umi-umi@users.noreply.github.com>
Co-authored-by: shela <shelaf@users.noreply.github.com>
Co-authored-by: s-show <s1shimz@gmail.com>
2020-06-21 20:17:16 +09:00
Ryan
32340e14fb
Update newbs MSYS2 pacman instructions (#9445) 2020-06-21 10:54:53 +01:00
AlexOConnorHub
b7da69ec85
Adding information to feature_encoders.md (#9486)
Co-authored-by: Ryan <fauxpark@gmail.com>
2020-06-21 17:10:01 +10:00
Konstantin Đorđević
02781979d6
[Docs] Improve Unicode documentation (#8676) 2020-06-20 21:58:48 +01:00
Takeshi ISHII
580cb2c1df
[Update] Files with Japanese translations related to #8822 (#9455)
* The TAG of the original document has been updated to facilitate future verification.

* The TAG of the original document has been updated to facilitate future verification.

* The TAG of the original document has been updated to facilitate future verification.
2020-06-20 21:02:16 +09:00
Joshua Diamond
18e561b82c
Fix incorrect delay when setting WS2812 (and similar) leds (#9302)
* Fix incorrect delay when setting WS2812 (and similar) leds

* Add documentation for WS2812_DELAY_MICROSECONDS

* Remove improper cast to uint8_t

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

* Remove unneeded cast to uint8_t and correct math

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

* microseconds -> µs

Co-authored-by: Ryan <fauxpark@gmail.com>

* Make documentation better match the spec sheet.

Co-authored-by: Ryan <fauxpark@gmail.com>

* Rename macro to match spec sheet

* Further correction to the delay maths for the SPI case.

Co-authored-by: Joel Challis <git@zvecr.com>

* Move ws2812_common.h to the drivers directory

* Revert "Further correction to the delay maths for the SPI case."

This reverts commit e61b56a2cfc7dfec9992a7a3af92afa50e5b8ec0.

* Remove ws2812_setleds_pin(); consolidate ws2812.h

Co-authored-by: Sergey Vlasov <sigprof@gmail.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Joel Challis <git@zvecr.com>
2020-06-20 12:59:28 +10:00
Xelus22
c785148445
STM32 WS2812 Open Drain Configuration (#9414)
* update docs stm32 only and applies  to all 3 driver
* cformat
2020-06-20 08:35:32 +10:00
Takeshi ISHII
016b4be751
Update docs/ja/feature_backlight.md: apply #9043's change (#9454) 2020-06-19 04:53:16 +09:00
Jason Laqua
f7eb030e91
Standardize how unicode is processed (fixes #8768) (#8770)
Co-authored-by: Konstantin Đorđević <vomindoraan@gmail.com>
2020-06-18 08:07:34 +01:00
Ryan
1a159a38ed
Clean up Tap Dance docs (#9372)
* Clean up Tap Dance docs

* Add heading IDs for translation
2020-06-17 17:10:35 -07:00
Reed
8e0af2f5ba
[Docs] Fix link to mod_tap.md in the one_shot_keys.md file (#9380) 2020-06-15 02:55:00 -07:00
jems-lee
294cfd8d33
Delete trailing period in documentation (#9416) 2020-06-15 02:49:36 +10:00
umi
044b4aaf01
[Docs] Japanese translation of docs/feature_split_keyboard.md (#9031)
* add feature_split_keyboard.md translation

* add header for git

* update based on comment

* update based on comment
2020-06-12 23:50:19 -07:00
Sergey Vlasov
0cb4da2c74
Really fix Ubuntu/Debian setup when $PATH contains spaces (#9370)
PR #9307 fixed the immediately visible problem (the command that was
added to $HOME/.bashrc was incorrect because of missing quotes around
paths with spaces).  However, the modified command is still wrong - it
captures the value of $PATH at the setup time, and the resulting command
written out to $HOME/.bashrc will overwrite $PATH with that captured
value, ignoring any changes in the environment.  This may be especially
important for WSL, where the initial value of $PATH in Linux includes
everything which has been added to %PATH% on the Windows side; after
adding that command to $HOME/.bashrc the WSL environment will no longer
pick up any changes made by newly installed Windows software.

Instead of that, use single quotes around the command, so that the
environment variables are not expanded at the setup time, and the
command that is added to $HOME/.bashrc becomes exactly this:

    PATH="$HOME/.local/bin:$PATH"

This command will use the $HOME and $PATH environment variable values at
the time the command is executed, not at the time the QMK setup is
performed, so any further updates to $PATH are taken into account.
Double quotes also ensure that the command is safe even if the values of
those environment variables contain spaces.
2020-06-11 12:26:10 +01:00
neon4272
97ddc7ea18
Fix Ubuntu/Debian setup when $PATH contains spaces (#9307)
* Change `echo` to `export`

* Add `export` as a note under the `echo` command

* Remove note from last commit

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update docs/newbs_getting_started.md

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update docs/newbs_getting_started.md

Add 1 line of whitespace under note

Co-authored-by: Ryan <fauxpark@gmail.com>

Co-authored-by: Ryan <fauxpark@gmail.com>
2020-06-10 23:46:13 +01:00
Nick Brassel
3afd2d81b8
Add documentation for selecting an Arm MCU (#9046)
* Initial doco write-up.

* Update docs/platformdev_selecting_arm_mcu.md

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

* Apply suggestions from code review

Co-authored-by: Ryan <fauxpark@gmail.com>

Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
2020-06-10 23:32:58 +01:00
precondition
2543bad250
[Docs] Fixed the hyperlink to /users/_example/. (#9326) 2020-06-10 15:27:25 -07:00
Drashna Jaelre
573d1fbb92
Include pointing_device_send in docs (#9185) 2020-06-10 23:18:53 +01:00
itsnoteasy
7aa4cc9603
adds support for the atmega328 (#9043)
Co-authored-by: Ryan <fauxpark@gmail.com>
2020-06-10 22:23:11 +01:00
umi
b7cb4111ea
[Docs] Japanese translation of docs/feature_wpm.md (#9254)
* add feature_wpm.md translation

* update based on comment

* update based on comment

* update based on comment
2020-06-10 21:04:39 +09:00
Ryan
3736db6081
Add OS compatibility matrix for basic keycodes (#8557) 2020-06-09 12:28:36 +01:00
Takeshi ISHII
b19187c62c
[Update] Japanese translation of newbs_learn_more_resources.md (#9288)
* Updated the Japanese translation of newbs_learn_more_resources.md

Updated the Japanese translation of newbs_learn_more_resources.md to 0.9.0.

* update docs/ja/newbs_learn_more_resources.md

* update ja/newbs_learn_more_resources.md
2020-06-09 00:04:14 +09:00
Takeshi ISHII
4a7725b3ee
[Update] Japanese translation of docs/newbs_testing_debugging.md. (#9286)
* Updated the Japanese translation of newbs_testing_debugging.md.

Updated the Japanese translation of newbs_testing_debugging.md to 0.9.0.

* Update docs/ja/newbs_testing_debugging.md

Co-authored-by: s-show <s1shimz@gmail.com>

* Update docs/ja/newbs_testing_debugging.md

Co-authored-by: shela <shelaf@users.noreply.github.com>

* Update docs/ja/newbs_testing_debugging.md

Co-authored-by: shela <shelaf@users.noreply.github.com>

Co-authored-by: s-show <s1shimz@gmail.com>
Co-authored-by: shela <shelaf@users.noreply.github.com>
2020-06-09 00:02:32 +09:00
umi
d7523c1260
[Docs] Japanese translation of docs/feature_ps2_mouse.md (#9030)
* add feature_ps2_mouse.md translation

* update based on comment

* update based on comment

* update based on comment

* update based on comment
2020-06-08 02:26:30 +09:00
umi
a7f093b40c
[Docs] Japanese translation of docs/feature_terminal.md (#9033)
* add feature_terminal.md translation

* add header for git

* update based on comment
2020-06-08 02:24:35 +09:00
Pete Johanson
b9a38487f3
[Docs] Update udev rules to use TAG+="uaccess". (#8750) 2020-06-07 09:06:55 +01:00
umi
9f400794c0
[Docs] Japanese translation of docs/feature_swap_hands.md (#9032)
* add feature_swap_hands.md translation

* update based on comment

* back to original translation
2020-06-07 03:08:24 +09:00
Takeshi ISHII
3972978c8d
The TAGs of the original document has been updated to facilitate future verification. (#9285) 2020-06-05 21:49:34 +09:00
umi
b8ddfd34ec
[Docs] Japanese translation of docs/feature_mouse_keys.md (#8992)
* add feature_mouse_keys.md translation

* update based on comment

* update based on comment

* update based on comment

* update based on comment

* update based on comment
2020-06-01 17:28:41 -07:00
Kimat Boven
4f6f7b59cf
French (Belgium) was missing (#9245) 2020-06-01 23:14:14 +10:00
Joshua Diamond
e2e287ec5f
Option to allow lighting layers when RGB Lighting is off (#9051) 2020-06-01 11:02:28 +02:00
James Young
fced377ac0
2020 May 30 Breaking Changes Update (#9215)
* Branch point for 2020 May 30 Breaking Change

* Migrate `ACTION_LAYER_TOGGLE` to `TG()` (#8954)

* Migrate `ACTION_MODS_ONESHOT` to `OSM()` (#8957)

* Migrate `ACTION_DEFAULT_LAYER_SET` to `DF()` (#8958)

* Migrate `ACTION_LAYER_MODS` to `LM()` (#8959)

* Migrate `ACTION_MODS_TAP_KEY` to `MT()` (#8968)

* Convert V-USB usbdrv to a submodule (#8321)

* Unify Tap Hold functions and documentation (#8348)

* Changing board names to prevent confusion (#8412)

* Move the Keyboardio Model01 to a keyboardio/ subdir (#8499)

* Move spaceman keyboards (#8830)

* Migrate miscellaneous `fn_actions` entries (#8977)

* Migrate `ACTION_MODS_KEY` to chained mod keycodes (#8979)

* Organizing my keyboards (plaid, tartan, ergoinu) (#8537)

* Refactor Lily58 to use split_common (#6260)

* Refactor zinc to use split_common (#7114)

* Add a message if bin/qmk doesn't work (#9000)

* Fix conflicting types for 'tfp_printf' (#8269)

* Fixed RGB_DISABLE_AFTER_TIMEOUT to be seconds based & small internals cleanup (#6480)

* Refactor and updates to TKC1800 code (#8472)

* Switch to qmk forks for everything (#9019)

* audio refactor: replace deprecated PLAY_NOTE_ARRAY (#8484)

* Audio enable corrections (2/3) (#8903)

* Split HHKB to ANSI and JP layouts and Add VIA support for each (#8582)

* Audio enable corrections (Part 4) (#8974)

* Fix typo from PR7114 (#9171)

* Augment future branch Changelogs (#8978)

* Revert "Branch point for 2020 May 30 Breaking Change"
2020-05-30 13:14:59 -07:00
Ryan
00c1401d3c
Documentation for keymap_extras (#9194) 2020-05-27 01:52:48 +01:00
Zach White
751316c344
[CLI] Add a subcommand for getting information about a keyboard (#8666)
You can now use `qmk info` to get information about keyboards and keymaps.

Co-authored-by: Erovia <Erovia@users.noreply.github.com>
2020-05-26 13:05:41 -07:00
umi
451c472d1d
[Docs] Japanese translation of docs/feature_pointing_device.md (#8993)
* add feature_pointing_device.md translation

* update based on comment

* update based on comment

* update based on comment

* update based on comment
2020-05-26 17:14:58 +09:00
Ryan
e4823aadec
Fix capitalisation of "GitHub" (#9184) 2020-05-25 19:43:14 -07:00
Takeshi ISHII
f66680d233
Fixed the indentation of the sample code in feature_pointing_device docs (#9177)
* Fixed the indentation of the sample code in docs/feature_pointing_device.md sample.

* Update docs/feature_pointing_device.md

Co-authored-by: Joel Challis <git@zvecr.com>

Co-authored-by: Joel Challis <git@zvecr.com>
2020-05-23 23:57:59 +01:00
Joel Challis
6d84795bc1
Update ARM split keyboard docs (#9160)
* Update ARM split keyboard docs

* Update docs/serial_driver.md

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

Co-authored-by: Nick Brassel <nick@tzarc.org>
2020-05-22 06:20:46 +10:00
Joel Challis
65150984bd
ARM split - Add uart half duplex transport support (#7987)
* ARM split - Add uart half duplex transport support

* Fix for f103

* initial full duplex pass

* partially remove full duplex

* Correct speeds within driver docs

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

Co-authored-by: Nick Brassel <nick@tzarc.org>
2020-05-21 18:00:21 +01:00
Ryan
9c8f61dfa0
[Docs] newbs_flashing.md: place bootloader instructions before Toolbox intro (#9077)
* newbs_flashing.md: place bootloader instructions before Toolbox intro

* Update docs/newbs_flashing.md

* More wordsmithing, point ARM users at Discord if all else fails

* Link Discord
2020-05-21 09:24:39 -07:00
Nick Brassel
d1df576ece
Allow for overriding RAW endpoint usage page and ID. (#8834)
* Allow for overriding RAW endpoint usage page and ID.

* Move usb_descriptor_common.h.

* Docs update.
2020-05-21 20:31:42 +10:00
Pete Johanson
3ad2be52a7
CLI: Improve experience when running qmk setup on FreeBSD. (#8798)
* CLI: Improve experience when running `qmk setup` on FreeBSD.

* Install the `avrdude` package as well.
* Switch to installing python packages w/ `--user` flag.
* Basic getting started sections for FreeBSD.
* Update `util/freebsd_install.sh` for root/non-root branches.

* Add ID to doc section.

Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>

* Add ID to another docs section.

Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>

* Use `; then` in script for consistency.

Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>

* Updated to use sudo in one shot if available.

* Apply suggestions from code review

Co-authored-by: Erovia <Erovia@users.noreply.github.com>

* Style fixes for latest version in master.

* Apply suggestions from code review

Co-authored-by: Ryan <fauxpark@gmail.com>

Co-authored-by: skullydazed <skullydazed@users.noreply.github.com>
Co-authored-by: Erovia <Erovia@users.noreply.github.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
2020-05-20 08:09:13 -07:00
Joel Challis
0fbcb41c85
Reintegrate previous docker docs (#9084) 2020-05-19 21:54:55 -07:00
skullY
fcf150bd82 Streamline the macos install process 2020-05-18 22:46:33 -07:00
umi
ee2eb01653
[Docs] Japanese translation of docs/feature_led_matrix.md (#8991)
* add feature_led_matrix.md translation

* update based on comment

* update based on comment
2020-05-18 20:37:25 -07:00
umi
0bece1d442
[Docs] Japanese translation of docs/feature_layouts.md (#8949)
* add feature_layouts.md translation

* update based on comment

* update based on comment
2020-05-18 20:29:04 -07:00
umi
be69dd22e8
[Docs] Japanese translation of docs/feature_thermal_printer.md (#9034)
* add feature_thermal_printer.md translation
2020-05-18 19:58:04 -07:00
umi
b9675d2106
[Docs] Japanese translation of docs/feature_velocikey.md (#9035)
* add feature_velocikey.md translation

* update based on comment

* update based on comment
2020-05-18 19:50:32 -07:00
umi
f689f043b1
[Docs] Japanese translation of docs/feature_leader_key.md (#8950)
* add feature_leader_key.md translation

* update based on comment

* set link as lang dir

* update based on comment

* update based on comment

* update based on comment
2020-05-18 19:43:36 -07:00
Nick Brassel
54b04d9665
Add SPI 25xx EEPROM support. (#8780) 2020-05-19 10:34:00 +10:00
Drashna Jaelre
d0e0202b27
Add query functions for RGB Light and RGB Matrix (#8960)
* Add additional query functions for RGBLIGHT

* Add additional query functions for RGB Matrix

* Change names of enable check functions

* Fix macro for rgb matrix takeover of rgblight functions

* Add documentation for rgb_matrix_get_hsv()

* Add *_get_hsv function to rgblight
2020-05-18 06:05:35 -07:00
Nick Blyumberg
142ebaea46
[Docs] Clarify layer transparency keymap.md (#9081)
* Revised the grammar and clarity of the Layer Precedence and Transparency

* Update docs/keymap.md

* Update docs/keymap.md

* Update docs/keymap.md

* Update docs/keymap.md

* Update docs/keymap.md

* Update docs/keymap.md

* Update docs/keymap.md
2020-05-16 00:35:19 -07:00
Ryan
f66850bfd0
Improve stock bootloader list (#9067)
* Improve stock bootloader list

* Switch version numbers on USB64/128 bootloaders

* Unix line endings for PS2AVRGB bootloader

* Update PS2AVRGB bootloader to 1.0.1

* Also mention bootloader rule

* Didn't need to change the links
2020-05-13 19:32:43 -07:00
Zsolt Parragi
805f5cb72b
One shot support for swap hands (#8590)
This commits add the SH_OS keycode, which works similarly to one shot
layers:
* while pressed, the keyboard is swapped
* if no keys were pressed while it was pressed, the next key press is
swapped

SH_OS also supports chaining with one shot layers:
OSL(x) + SH_OS + key interprets the key press on the oneshot layer.

The ONESHOT_TIMEOUT setting used by one shot keys and layers is also
used by oneshot swap hands. In the above chaining scenario the timeout
of the oneshot layer is reset when swap hands is activated.

Resolves #2682
2020-05-14 07:36:55 +10:00
Joshua Diamond
a8a8bf0ff3
Allow expanding from 8 to 32 RGB Lighting Layers (#8941)
* Allow 16 lighting layers

* Require #define RGBLIGHT_LAYERS_16 to enable 16 layers

* Override RGBLIGHT_MAX_LAYERS to set maximum number of lighting layers

* Enforce lower bound on RGBLIGHT_MAX_LAYERS

Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>

* Fix an error in the check for valid RGBLIGHT_MAX_LAYERS

* Don't use bitfield / PACKED, as it causes bloat

* Update documentation re: up to 32 lighting layers

* Run cformat

* Add note about increasing FW size in docs/config_options.md

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

* Remove no-longer-valid comment

* Add doc note that split sync will be slower

Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
2020-05-13 21:39:05 +01:00
floookay
d846660e00
fixed typo for clear lcd screen function in hd44780 docs (#9086)
* fixed typo for clear lcd screen function

brought to attention by #9085

* fixed typo for clear lcd screen function (ja docs)
2020-05-13 19:06:41 +01:00
James Young
7b11dcce10
Docs: fix links in feature_hd44780.md (#9053)
The referenced site was moved.
2020-05-09 22:47:11 +01:00
Joshua Diamond
2fe7e221ec
New RGB Lighting effect: Twinkle (#8887)
* Add twinkle RGB Lighting effect

* 2nd twinkle algo - double-buffering

* Further refinement: Per-LED twinkle

* Add documentation for Twinkle RBG Lighting mode

* Bias twinkle saturation closer to the set value

* Fix whitespace
2020-05-09 01:56:16 -07:00
Joshua Diamond
e0f548085c
Add ability to blink lighting layer for a specified duration (#8760)
* Implement momentarily blink of lighting layers

* Refactor spidey3 userspace to use rgb layer blink

* Remove un-necessary line from example in documentation

* Revert "Refactor spidey3 userspace to use rgb layer blink"

This reverts commit 831649bb680c41c6d663ae6fa86d13f4f8bebdd8.

* Adds a missing bit of documentation about lighting layer blink

* Update docs/feature_rgblight.md per suggestions

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

* Update docs/feature_rgblight.md per suggestions

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

* Update docs/feature_rgblight.md per suggestions

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

* cformat, as suggested

Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
2020-05-09 01:38:33 -07:00
Joel Challis
e182a38e7c
Add redirect for old getting started links (#8987) 2020-05-02 04:29:55 +01:00
Ahmed Elshafey
750c7c2bdb
[Documentation] Added raw hid documentation page (#7640)
* Added raw hid feature documentation page

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <fauxpark@gmail.com>

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <fauxpark@gmail.com>

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <fauxpark@gmail.com>

* Update docs/features.md

Co-Authored-By: fauxpark <fauxpark@gmail.com>

* added feature_rawhid.md to _summary.md in docs

* fixed _summary.md order

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <fauxpark@gmail.com>

* Update feature_rawhid.md

Removed the useless bit about finding usage page and usage.

* Update feature_rawhid.md

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <nick@tzarc.org>

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <nick@tzarc.org>

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <nick@tzarc.org>

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <nick@tzarc.org>

* Remove teensy client, small origanization fixes

* Fixed merge conflicts
Removed features.md
Updated _summary.md with new format and added RAW HID entry under Software Features

* Added rawhid feature page
Messy is what you get when you don't do things right the first time

Co-authored-by: fauxpark <fauxpark@gmail.com>
Co-authored-by: Nick Brassel <nick@tzarc.org>
2020-05-01 23:41:58 +10:00
umi
830bd5460c
[Docs] Japanese translation of docs/feature_key_lock.md (#8948)
* add feature_key_lock.md translation

* update based on comment

* set link as lang dir
2020-05-01 01:43:22 +09:00
umi
9f54a26dc0
[Docs] Japanese translation of docs/feature_haptic_feedback.md (#8874)
* add feature_haptic_feedback.md translation

* update based on comment

* update based on comment
2020-05-01 01:42:33 +09:00
JohSchneider
d26a14c169
add 'togglePin' convenience function (#8734)
* add 'togglePin' conveniance function

for AVR and chibios

* drop outmost parantheses

Co-Authored-By: Konstantin Đorđević <vomindoraan@gmail.com>

* toggle pin on avrs

toggle a pin configured as output by writing the corresponding bit to the PIN register

Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>

* togglepin: add documentation for newly added function

* Update docs/internals_gpio_control.md

Co-Authored-By: Konstantin Đorđević <vomindoraan@gmail.com>

* on AVR: use PORTD to toggle the output

... since not all MCUs support toggling through writing to PIN

Co-Authored-By: Ryan <fauxpark@gmail.com>

Co-authored-by: Johannes <you@example.com>
Co-authored-by: Konstantin Đorđević <vomindoraan@gmail.com>
Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
2020-04-29 04:04:29 -07:00
Nick Brassel
b17482c3fd
Add SPI master for ChibiOS/ARM. (#8779) 2020-04-29 14:01:20 +10:00
Alexander Hart
e02a3c559d
Edit Unit Testing Documentation (#8961) 2020-04-29 07:39:08 +10:00
Erovia
2c0deb8a13
Update and try to clarify the CLI installation on Linux (#8783)
* Update and try to clarify the CLI installation on Linux

* Update commands, add note for Debian/Ubuntu

* Update docs/newbs_getting_started.md

Co-Authored-By: Joel Challis <git@zvecr.com>

Co-authored-by: Joel Challis <git@zvecr.com>
2020-04-27 20:29:31 +01:00
umi
82ae6ee007
[Docs] Japanese translation of docs/feature_grave_esc.md (#8873)
* add feature_grave_esc.md translation

* update based on comment

* update based on comment

* update based on comment

* update based on comment

* update based on comment
2020-04-27 00:47:15 -07:00
umi
f220e7d713
[Docs] Japanese translation of docs/feature_hd44780.md (#8875)
* add feature_hd44780.md translation

* update based on comment

* update based on comment

* update based on comment
2020-04-27 00:43:41 -07:00
umi
6ec3cc029e
[Docs] Japanese translation of docs/feature_dynamic_macros.md (#8842)
* add feature_dynamic_macros.md translation

* add header

* add header

* update based on comment

* update based on comment
2020-04-26 23:10:05 +09:00
Takeshi ISHII
bafa35ff46
fix sample code indent in feature_encoders.md (#8883) 2020-04-23 08:56:22 +10:00
umi
d0c3a4c8d5
[Docs] Japanese translation of docs/feature_encoders.md (#8843)
* add feature_encoders.md translation

* update based on comment
2020-04-20 15:36:04 -07:00
umi
0d658e0c95
[Docs] Japanese translation of docs/feature_command.md (#8672)
* add feature_command.md translation

* update based on comment
2020-04-20 14:49:12 +09:00
Chris Ko
9b70e53508
[Docs] Fixed minor typos (#8860) 2020-04-19 23:04:26 +01:00
skullydazed
8c97b4a3a4
Add a syllabus to guide people who are learning QMK (#8816) 2020-04-19 09:08:38 +02:00
skullydazed
66d94dc22a
Move everything to Python 3.6 (#8835) 2020-04-18 22:00:56 +02:00
skullydazed
7918f7d61d
Document the Proton C pins for manual Pro Micro conversion (#7043) 2020-04-18 10:58:59 -07:00
Ryan
bc13dcd349
Remove Atmel FLIP from install scripts and documentation (#8822) 2020-04-17 09:50:58 +02:00
umi
5607af8524
[Docs] Japanese translation of docs/feature_combo.md (#8671)
* add feature_combo.md translation

* change tiny word

* update based on comment

* update based on comment
2020-04-15 22:08:00 -04:00
mimkorn
3cea9fedff
Add missing repository name to qmk setup w/ github (#8792)
Using just qmk setup <github_username> would fail w/ "Could not find repo github.com/<username>, whereas the repo is actually after another slash after the user name. Can consider changing code to add the default forked repo name if slash is not detected in the arg.
2020-04-14 21:03:13 +10:00
umi
355b693e4e
[Docs] Japanese translation of docs/feature_dip_switch.md (#8673)
* add git_dip_switch.md translation

* update based on comment

* update based on comment
2020-04-13 10:25:57 -07:00
Nick Brassel
46e4493761
Fix AVR SPI parameter configuration, remove timeouts due to sync protocol. (#8775) 2020-04-13 17:09:50 +10:00
Nick Brassel
05e9ff6554
Add support for hardware and board initialisation overrides. (#8330)
* Add support for hardware and board initialisation overrides.

* qmk cformat.

* Add some documentation.

* Docs clarity.

* Make early_hardware_init_pre a no-op for now, until migrations occur.

* Doco update

* Make distinction between keyboard and ChibiOS board in docs

* Doc anchors.

* Update tmk_core/protocol/chibios/main.c

Co-Authored-By: Joel Challis <git@zvecr.com>

* Rework bootloader entry to be off by default, allow opting-in.

Co-authored-by: Joel Challis <git@zvecr.com>
2020-04-13 09:39:38 +10:00
Konstantin Đorđević
370577e4ed
Add *OPT aliases for *ALT keycodes and macros (#8714) 2020-04-12 11:37:55 -07:00
Joshua Moses Diamond
750179e111
Fix a couple of typos that were causing confusion (#8767) 2020-04-12 16:22:59 +10:00
Purdea Andrei
b8c3f4c60b
quantum/debounce: Added sym_pk debounce algorithm (#8587)
* quantum/debounce: Added sym_pk debounce algorithm

* Apply suggestions from code review

Co-Authored-By: Ryan <fauxpark@gmail.com>

* quantum/debounce/sym_pk: delete comments and rename functions following code review

* quantum/debounce/sym_pk: Modifications for code readability according to code review

* quantum/debounce/sym_pk: Modifications for code readability according to code review (2)

* quantum/debounce/sym_pk: code review: cleaner code

Co-Authored-By: Nick Brassel <nick@tzarc.org>

Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Nick Brassel <nick@tzarc.org>
2020-04-11 21:29:48 +10:00
Manna Harbour
07c75feba3
Add PS2_MOUSE_ROTATE to compensate for device orientation (#8650)
* Add PS2_MOUSE_ROTATE to compensate for device orientation

* fixup! Add PS2_MOUSE_ROTATE to compensate for device orientation

* Reformat with IndentPPDirectives: AfterHash as per #6316
2020-04-09 01:29:27 -07:00
Konstantin Đorđević
be2f5816b6
Fix compile issues related to NO_ACTION_MACRO/FUNCTION and LTO_ENABLE (#8663)
* Define NO_ACTION_MACRO/FUNCTION in header instead of makefile when LTO is enabled

Currently, boards and keymaps that define NO_ACTION_MACRO/FUNCTION unconditionally
will not compile with LTO_ENABLE (#8604). This fixes the issue by moving the
definitions from common.mk to action.h, which enables us to check for previous
definitions of those macros (this cannot be done in a makefile).

* Remove LTO checks in templates

Since now NO_ACTION_MACRO/FUNCTION are defined as needed in action.h (which is
included by quantum.h), checking for LTO in keyboard and user code is no
longer required.

* Update LTO_ENABLE docs
2020-04-09 00:18:30 +01:00
Erovia
21799be1ca Make dedicated sections for user/dev commands in docs 2020-04-08 09:31:14 -07:00
Erovia
5cfc3ce02e Rebase on master, hide some other subcommands
The list of hidden subcommands were approved by @skullydazed ;)
Currently hidden if 'user.developer' is not True:

  - cformat
  - docs
  - kle2json
  - pyformat
  - pytest
2020-04-08 09:31:14 -07:00
Erovia
c61f016fa4 CLI: Add development mode support
Hide development specific options and don't require dev modules unless
`user.developer` is set to `True`.
2020-04-08 09:31:14 -07:00
Ryan
400ca2d035
spi_master for AVR (#8299)
* Change _delay_ms/us() to wait_ms/us()

* Switch to platform-agnostic GPIO macros

* Add AVR spi_master and migrate Adafruit BLE code

* Set verbose back to false

* Add clock divisor, bit order and SPI mode configuration for init

* Add start and stop functions

* Move configuration of mode, endianness and speed to `spi_start()`

* Some breaks here would be good

* Default Adafruit BLE clock divisor to 4 (2MHz on the Feather 32U4)

* Remove mode and divisor enums

* Add some docs

* No hr at EOF

* Add links in sidebar
2020-04-08 11:04:31 +10:00
Konstantin Đorđević
f4b67cde8a
Update C coding conventions to match .clang-format config for i… (#8717)
* Update C coding conventions to match current .clang-format config for indenting PP directives

* Make indenting guideline clearer
2020-04-07 14:14:08 +10:00
umi
808aab8496
add japanese translation (feature part 01) (#8196)
* add feature part 01

* update sentences

* update sentences

* update sentences

* update file based on comment

* leave ctrl, shift, alt key name as alphabet

* update file based on comment

* update file based on comment

* update file based on comment

* update file based on comment

* remove unnecessary space on define line

* update sentence based on pull request's comment

* translate 'breathing' in document

* change expression in table

* update file based on comment

* change the word 'brightness', and update based on comment

* update based on comment

* update based on comment

* add language directory name to each internal link

* update based on comment

* update based on comment
2020-04-02 12:56:59 +09:00
shela
1962135418
[Docs] Update Japanese translation of i2c_driver.md (#8523)
* Update Japanese translation of i2c_driver.md

* Apply a part of suggestions from code review
2020-04-01 15:05:45 +09:00
Takuya Urakawa
d79be051dd
[Docs] Japanese translation of hardware_*.md (#8278)
* add docs/ja/hardware.md

* add docs/ja/hardware_avr.md

* add docs/ja/hardware_drivers.md

* add docs/ja/hardware_keyboard_guidelines.md

* update hardware.md

* add space around alphabet word

* fix link tag

* Apply suggestions from code review

Co-Authored-By: shela <shelaf@users.noreply.github.com>

* remove ja/hardware.md

* Apply suggestions from code review

Co-Authored-By: shela <shelaf@users.noreply.github.com>
Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>

* match word matrix with other translations

* Apply suggestions from code review

Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>

Co-authored-by: shela <shelaf@users.noreply.github.com>
Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
2020-04-01 15:04:16 +09:00
Bram de Wilde
2c201ab9ad Update newbs_getting_started.md
qmk is not available in the official Arch repositories. It is in the AUR, this install command will work if user has `yay` installed.
2020-03-31 14:26:19 -07:00
Konstantin Đorđević
bdfdc506da
Rename UC_OSX (and related constants) to UC_MAC (#8589)
* Rename UC_OSX (and related constants) to UC_MAC

* Update UNICODE_SONG_OSX references to UNICODE_SONG_MAC

* Update UC_M_OS references to UC_M_MA

* Add UC_OSX alias for backwards compatibility

* Add deprecation warning for UC_OSX to Unicode docs

* Add UC_M_OS alias for backwards compatibility

* Update newly found UC_M_OS and UNICODE_SONG_OSX references

* Add legacy UNICODE_MODE_OSX alias, revert changes to user keymaps

* Add legacy UNICODE_SONG_OSX alias, revert changes to user keymaps

* Replace removed sounds in Unicode song doc examples
2020-03-31 18:28:43 +02:00
shela
8566a684bc
Add Japanese translation of cli_commands.md (#8513) 2020-03-31 19:21:47 +09:00
shela
28d3c29704
[Docs] Update Japanese translation of cli.md (#8510)
* Update Japanese translation of cli.md

* Update docs/ja/cli.md

Co-Authored-By: s-show <s1shimz@gmail.com>

Co-authored-by: s-show <s1shimz@gmail.com>
2020-03-31 19:19:15 +09:00
shela
dd5cb64851
[Docs] Update Japanese translation of faq related documents (#8521)
* Update Japanese translation of faq related documents

* Update docs/ja/faq_general.md

Co-Authored-By: s-show <s1shimz@gmail.com>

Co-authored-by: s-show <s1shimz@gmail.com>
2020-03-31 19:12:54 +09:00
shela
b9a64ec93b Update Japanese translation of config_options.md 2020-03-31 19:06:18 +09:00
shela
c9067dfe4f Update Japanese translation with prefix 'getting' 2020-03-31 18:30:21 +09:00
Takeshi ISHII
dc98d44582
[Docs] added the description of the reading order of the rules.mk files. (#8566)
* added the description of the reading order of the rules.mk files.

* Update docs/hardware_keyboard_guidelines.md

Co-Authored-By: Ryan <fauxpark@gmail.com>

* Update docs/hardware_keyboard_guidelines.md

Co-Authored-By: Ryan <fauxpark@gmail.com>

Co-authored-by: Ryan <fauxpark@gmail.com>
2020-03-29 13:00:47 -07:00
fauxpark
11f12d386b Fix wrong python-pip package for MSYS setup instructions 2020-03-26 07:50:22 -07:00
Takeshi ISHII
5bd0a5a585
[Docs] added the description of the reading order of the config.h files. (#8545)
* added the description of the reading order of the config.h files.

* Update docs/hardware_keyboard_guidelines.md

* Update docs/hardware_keyboard_guidelines.md

* Added a description of post_config.h.

* sample bug fix

* sample update

* Update docs/hardware_keyboard_guidelines.md

* Update docs/hardware_keyboard_guidelines.md

* update docs/hardware_keyboard_guidelines.md

* Update docs/hardware_keyboard_guidelines.md
2020-03-25 21:13:16 -07:00
Drashna Jaelre
5075a1d9e4
[Docs] Update RGB Matrix docs with function refs (#8367)
* [Docs] Update RGB Matrix docs with function refs

* Fix up code samples

* suggestions by noroadsleft

* Fix small typo

Co-authored-by: James Young <xxiinophobia@yahoo.com>
2020-03-24 18:54:38 -07:00
shela
963bba1fc3
[Docs] Update Japanese translation of custom_quantum_functions.md (#8520) 2020-03-24 11:59:31 -07:00
shela
571a589cfa
[Docs] Update Japanese translation of _summary.md (#8508)
* Update Japanese translation of _summary.md

* Update translation

* Update translation
2020-03-24 11:51:45 -07:00
shela
3c2d5599b9
[Docs] Update Japanese translation of README.md (#8507)
* Update Japanese translation of README.md

* Apply suggestions from code review

* Apply suggestions from code review

* Update translation

Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
2020-03-24 01:05:08 -07:00
shela
e05e671871 Update Japanese translation of flashing.md 2020-03-24 14:26:11 +09:00
shela
2d5b492550 Update Japanese translation of keymap.md 2020-03-24 14:24:19 +09:00
shela
ad8774d6fa Update Japanese translation of contributing.md 2020-03-24 14:19:25 +09:00
Drashna Jaelre
5117dff6a2
Add Post Processing to process_record (#4892)
* Improve process_record system

Code based on @colinta's

* Rename and better handle functions

* Fix incorrect function call to process_record_user

* Add documentation for post_process_record

* Add both get_event_keycode and get_record_keycode functions

And add some comments about these functions

* Update code format

* Cleanup merge artifacts
2020-03-23 00:29:05 +11:00
brickbots
bfb2f8e0a8
Add Word Per Minute calculation feature (#8054)
* Add Word Per Minute calculation feature

* Fix copyright info

* Remove header from quantum.c, setup overloadable keycode inclusion for WPM, update docs

* Simplify logic for keycode filtering

* Adding link from summary to wpm_feature info

* Update docs/feature_wpm.md

Typo in function prototype example in docs

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

* Add WPM transport via i2c

Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
2020-03-23 00:06:16 +11:00
shela
bea62add55
[Docs] Trivial documentation fix (#8509)
* Trivial documentation fix

* fix

* fix

* fix translation
2020-03-22 13:53:58 +11:00
Joel Challis
789e199450
Add support for Bootmagic lite when using SPLIT_HAND_PIN (#8347)
* Add support for Bootmagic lite when using SPLIT_HAND_PIN

* Deduplicate bootmagic_lite logic from within via

* Revert location of defaults so that user overrides still work for now

* Tidy up code slightly
2020-03-21 23:10:39 +00:00
James Young
a521fc2b6c
[Docs] Fixes for feature_rgblight.md (#8514)
* remove extra comma that breaks the RGBLight Layers example

* linting

- use four spaces instead of tabs for indenting
- remove trailing spaces
2020-03-21 20:11:06 +00:00
Drashna Jaelre
5df2424651
[Docs] Update layer documentation (#8371)
* [Docs] Update layer documentation

* Add layer_state_cmp functions

* Fix cut/copy/paste issue

* Add id tags

* Apply noroads corrections

* Move Layers section to separate document

* Fix ID tag for layers

* Use better name for summary/side bar

* Fix feature page linkage

As well as a small spell error close by

* Remove paper analogy for now
2020-03-21 10:17:02 -07:00
Ryan
0d189582c1
Update newbs installation procedure for MSYS2 (#8423) 2020-03-21 19:00:44 +11:00
Takeshi ISHII
6ba383cc5f
[Docs] Japanese translation of docs/custom_matrix.md (#8463)
* add docs/ja/custom_matrix.md

* add original document TAG

* update ja/custom_matrix.md

* 「マトリクス」to 「マトリックス」

* docs/ja/custom_matrix.md:update section title

* update docs/ja/custom_matrix.md

* update docs/ja/custom_matrix.md
2020-03-18 11:37:59 -07:00
Frei
6f55aa993a
[docs] Note the need to flash both sides for rgb layers. (#8467)
Update feature_rgblight.md to note that for split dual-mcu boards, 
both sides must be flash to get the new value of the rgblight_layers.

https://github.com/qmk/qmk_firmware/pull/7768#issuecomment-600237611
2020-03-17 23:43:04 +00:00
Joel Challis
567bfc97ac
ARM - ADC cleanup (#8385)
* Update switch to array to allow custom values

* Add adc keymap

* update docs to reflect alignment of default 10 bit

* start conversion to USE_ADCVn

* samplerate is hella wrong...stub out for now

* basic f1 and f4 functionality

* Tidy up current changes

* Restore old pinToMux function

* Add back sample rate for supported platforms

* F0 compile fixes

* wordsmithery

Co-Authored-By: Ryan <fauxpark@gmail.com>

* Remove reference to avr only function

Co-authored-by: Ryan <fauxpark@gmail.com>
2020-03-17 00:29:52 +00:00
Joel Challis
19dbcf3814
Document 'make all:<name>' (#8439)
* Document 'make all:<name>'

* add cli docs

* Apply suggestions from code review

Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>

Co-authored-by: skullydazed <skullydazed@users.noreply.github.com>
2020-03-16 14:27:19 +00:00
James Young
b272c035ba
[Docs] Random Fixes (#8340)
* fix CLI section links in the Summary

* fix heading in Pointing Device doc

* fix headings in PS/2 Mouse Support doc

* add explicit section ids to I2C Master Driver doc

* reformat GPIO Controls table

Much like the I2C Master Driver doc, I found this a bit less than ideal to read. (The table was actually wider than the space available for it.)

Reformatted so each GPIO function is an H3 heading, followed by a paragraph and a table of each architecture's old-style function.

* migrate changes from I2C Master Driver doc to Japanese translation

* add explicit anchors to I2C Master Driver docs

* fix code block language markers

The language markers are case-sensitive; using the wrong case means the syntax highlighting doesn't work.

Good: ```c
Bad: ```C

* restore Japanese I2C Master Driver doc to current master

Can't update the internal tracking references accurately until the changes to the English doc are committed to master.

* add explicit anchors to edited files

* change ChibiOS/ARM to ARM/ChibiOS

Because ARM/ATSAM is also a thing that exists.

* fix code block language markers again

Used the wrong markers in a few spots. Also these are apparently always supposed to be lowercase.

* add section anchors to cli.md

* restore table formatting on GPIO Control doc

* remove changes to _summary.md
2020-03-15 20:29:11 -07:00
skullydazed
dc68418660
Fix some broken links in the docs (#8394)
* fix some broken links

* remove duplicate and confusing material from cli.md

* Switch brazil to the 2 letter country code

* Update docs/_langs.md

Co-Authored-By: Ryan <fauxpark@gmail.com>

Co-authored-by: Ryan <fauxpark@gmail.com>
2020-03-15 07:48:44 -07:00
brickbots
499d7c8ce6
[Docs] Update to I2C docs: Clarify address expectation and return values (#8413)
* Clarifying docs for i2c

* Fix typo

* Fix up punctuation

* Implementing great suggestions

* Update docs/i2c_driver.md

* Update docs/i2c_driver.md
2020-03-15 00:17:48 -07:00
brickbots
b5be96f8bb
Adding OLED scroll setup functions (#8386)
* Adding scroll setup functions:

* Clarifying values stored in oled_scroll_speed
2020-03-14 21:04:34 +00:00
Takeshi ISHII
cde5237a88
fix two links on docs/other_eclipse.md (#8417) 2020-03-14 13:25:21 +00:00
Andy Jack
e6a9f700de
Update link for Learn Plover google site (#8410) 2020-03-14 11:06:54 +11:00
francislan
3cd2a27ac0
Decouple mouse cursor and mouse wheel in accelerated mode (#6685)
* Decouples mouse cursor and mouse wheel movements in accelerated mode.

* Fixed comment indentation.

* Updated docs

Co-authored-by: Francis LAN <francislan@google.com>
2020-03-13 12:49:44 -04:00
James Young
9046107183
Restore getting_started_github.md doc 2020-03-12 17:24:07 -07:00
Nick Brassel
1b267d4840
Fix darkmode (#8393)
* Rearrange the custom CSS a bit.

* fix css name

* add missing quote

* Fix up dark mode rendering. (#8392)

* Fix up dark mode rendering.

* Update index.html

* Fix up code blocks

* Fix code in page toc

* Update docs/qmk_custom_dark.css

Co-Authored-By: Ryan <fauxpark@gmail.com>

Co-authored-by: skullY <skullydazed@gmail.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
2020-03-12 18:17:47 +11:00
Nick Brassel
f2f2afe13b
Add support for STM32L0/L1 onboard EEPROM. (#8002)
* Add support for STM32L0/L1 onboard EEPROM.

* Update docs/eeprom_driver.md

Co-Authored-By: Joel Challis <git@zvecr.com>

Co-authored-by: Joel Challis <git@zvecr.com>
2020-03-12 12:59:55 +11:00
Drew Mills
5ac6fe1888
Add ADC support for STM32F3 and STM32F0 devices (#7681)
* Add ADC support for STM32F3 and STM32F0 devices

* Add section about configration options available to the ARM ADC implementation

* Fix STM32 typo
2020-03-11 15:38:39 +11:00
skullydazed
2a05d433c9
Rename qmk json-keymap to qmk json2c (#8372) 2020-03-10 13:51:19 -07:00
Nathan Gray
2ffb08843b
Feature: RGBLight layers (#7768)
* New feature: RGBLIGHT_LAYERS

This feature allows users to define multiple independent layers of lighting
that can be toggled on and off individually, making it easy to use your
RGB lighting to indicate things like active keyboard layer & modifier state.

* Demonstrate built in functions for layer state checking

Also link the video in the docs.

* Follow existing pattern for setting rgblight_status flags

* Eliminate rgblight_is_static_mode since it's not needed

Just check to see if the timer is enabled directly.
2020-03-10 12:50:01 -07:00
kymok
dd05007f3b
[Docs] i2c_driver translation to Japanese (#8274)
* [WIP] i2c_driver translation to ja

* update docs/ja/i2c_driver.md

* update docs/ja/i2c_driver.md

* align table + remove comment

* Update docs/ja/i2c_driver.md

* Update docs/ja/i2c_driver.md

* Update docs/ja/i2c_driver.md

* Update docs/ja/i2c_driver.md

* Update docs/ja/i2c_driver.md

* Update docs/ja/i2c_driver.md

* Update docs/ja/i2c_driver.md

* Update docs/ja/i2c_driver.md

* Update docs/ja/i2c_driver.md

* Update docs/ja/i2c_driver.md

* Update docs/ja/i2c_driver.md

* Update docs/ja/i2c_driver.md

* update docs/ja/i2c_driver.md

* Update docs/ja/i2c_driver.md

* Update docs/ja/i2c_driver.md

* Update docs/ja/i2c_driver.md

* add original document commit hash

Co-Authored-By: shela <shelaf@users.noreply.github.com>
2020-03-06 18:27:15 -08:00
brickbots
833c5ae87a
Buffer based OLED panning, write byte to buffer at arbitrary index (#8055)
* Add buffer based single line pan, arbitrary byte write to buffer

* Change dirty mask to inverse of OLED_BLOCK_TYPE for future proofing larger buffer sizes

* Updating docs to include new functions

* Updating to clarify scroll vs pan
2020-03-07 00:52:39 +00:00
James Young
73728e9bec
[Docs] Fix links in Config Options doc 2020-03-06 13:10:17 -08:00
Shaun
4e826ba61f
Correct typo in tap_hold.md (#8326)
Correct typo: "reasonal" to "reasonable"
2020-03-07 05:42:08 +11:00
James Young
76189d9a28 link the 2020 Feb 29 Breaking Changes changelog from the summary 2020-03-05 16:00:10 -08:00
James Young
2939751eb3 keycodes.md: hard-code section link id attributes 2020-03-05 16:00:10 -08:00
James Young
772bacb770 keycodes.md: don't use section headings as links
It prevents the Table of Contents from parsing that heading.
2020-03-05 16:00:10 -08:00
skullY
961477c791 make sure all our redirects are in order 2020-03-05 16:00:10 -08:00
skullY
6956784ac1 Add more call to action items 2020-03-05 16:00:10 -08:00
skullY
54c58ea6de Add explicit id tags to externally linked headers 2020-03-05 16:00:10 -08:00
James Young
a95a314f78 refactor How a Matrix Works doc 2020-03-05 16:00:10 -08:00
James Young
bc31ebd0c4 Hand Wire guide tidying, part 2 2020-03-05 16:00:10 -08:00
James Young
fbf27e7444 Hand Wire guide tidying 2020-03-05 16:00:10 -08:00
James Young
8b5ca3d110 clean up Firmware Setup section in Hand Wire guide 2020-03-05 16:00:10 -08:00
James Young
06708b9dc8 remove collapsible section for Compiling; redirect to Building Firmware doc 2020-03-05 16:00:10 -08:00
James Young
772d5264d6 replace QMK Toolbox image in Hand Wire guide
Showing a current version of QMK Toolbox
2020-03-05 16:00:10 -08:00
James Young
994de86121 restructure Hand Wire Guide 2020-03-05 16:00:10 -08:00
James Young
906bdce6ce split Hand Wire Preamble to a separate doc 2020-03-05 16:00:10 -08:00
James Young
3bd65d2173 CSS updates: ul and pre elements 2020-03-05 16:00:10 -08:00
James Young
d5f34c4810 Polish Configurator section 2020-03-05 16:00:10 -08:00
skullY
503b52652c Adjust the H2 and H2 margins 2020-03-05 16:00:10 -08:00
skullY
b5030907eb reduce the line-height of the sidebar 2020-03-05 16:00:10 -08:00
skullY
8b0fdc82dc rearrange the sidebar a bit 2020-03-05 16:00:10 -08:00
skullY
8d8d61b3c5 limit the TOC to H1 and H2 2020-03-05 16:00:10 -08:00
skullY
f86fd0cd14 remove line drawing chars 2020-03-05 16:00:10 -08:00
skullY
12e43230c6 make custom_keycode_names.md a faq entry instead 2020-03-05 16:00:10 -08:00
skullY
55c5b82638 reduce space on h3s 2020-03-05 16:00:10 -08:00
skullY
9035c3497e break feature_advanced_keycodes.md up into multiple files 2020-03-05 16:00:10 -08:00
skullY
5d35098bfc improve our docsify setup 2020-03-05 16:00:10 -08:00
skullY
8249a288d7 fix numbering 2020-03-05 16:00:10 -08:00
skullY
45e218ceec overhaul the newbs guide 2020-03-05 16:00:10 -08:00
skullY
86f6405574 More sidebar organization 2020-03-05 16:00:10 -08:00
skullY
99850aabca Add API documentation 2020-03-05 16:00:10 -08:00
James Young
3c98854044 update flashing.md
- minor typo on intro paragraph (the -> them)
- remove note about :check-size target (`make` task now does this automatically)
- heading level for Caterina commands section
- typo regarding Halfkay (come -> comes)
2020-03-05 16:00:10 -08:00
James Young
7b1b53054f update newbs_building_firmware.md
Update the text sample for when the compile task completes.
2020-03-05 16:00:10 -08:00
skullY
a701c15d87 Rework the newbs guide around the qmk cli 2020-03-05 16:00:10 -08:00
skullY
1b7fa46f8e Add dark mode support 2020-03-05 16:00:10 -08:00
James Young
58fb57bfa7 _summary.md: move Auto Shift page to Software Features category 2020-03-05 16:00:10 -08:00
James Young
6af58fc25e clean up links to keycode references in newbs_building_firmware_configurator.md 2020-03-05 16:00:10 -08:00
James Young
e01763b8e5 clean up callouts in newbs_building_firmware_configurator.md 2020-03-05 16:00:10 -08:00
James Young
cdb5c074d3 remove some unnecessary external links
Also clean up some trailing whitespace.
2020-03-05 16:00:10 -08:00
skullY
3f1e47dbcd rework the index page 2020-03-05 16:00:10 -08:00
skullY
d1c0710dec remove unused docs 2020-03-05 16:00:10 -08:00
skullY
5b14456082 more wip 2020-03-05 16:00:10 -08:00
skullY
d1c18086d2 wip 2020-03-05 16:00:10 -08:00
Drashna Jaelre
abd36de5ad
[Docs] Update ISP Flashing guide (#8149)
* [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-03-01 22:29:26 -08:00
James Young
f513a9193c
Fix the Breaking Changes doc again
WHAT YEAR IS IT?!
2020-02-29 20:46:48 -08:00
s-show
21715210e2
[Docs] translated 'feature_tap_dance.md' to japanese. (#8137)
* 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-02-29 20:22:15 -08:00
Joel Challis
f74c769a19
PWM DMA based RGB Underglow for STM32 (#7928)
* 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-03-01 13:05:56 +11:00
James Young
cae91510dc
Breaking Changes documentation fixes 2020-02-29 12:30:38 -08:00
James Young
26eef35f07
2020 February 29 Breaking Changes Update (#8064) 2020-02-29 11:59:30 -08:00
James Young
85041ff05b
Update Breaking Changes checklist 2020-02-27 12:03:30 -08:00
James Young
7eab5ad60f
Update Breaking Changes timeline
I've been working from one timeline while the docs said something different.
2020-02-27 11:17:23 -08:00
Nick Brassel
444fd3b1cc
Add support for delays in send_string. (#8244) 2020-02-27 20:38:19 +11:00
ridingqwerty
b949343b78
New feature: PERMISSIVE_HOLD_PER_KEY (#7994)
* Implement 'PERMISSIVE_HOLD_PER_KEY'

* Document 'PERMISSIVE_HOLD_PER_KEY'

Co-authored-by: GeorgeKoenig <35542036+GeorgeKoenig@users.noreply.github.com>
2020-02-25 13:25:52 -05:00
Ryan
bb8d4b4d23
send_unicode_string(): Add support for code points > 0xFFFF (#8236) 2020-02-25 12:54:51 +11:00
Ryan
371ff9dd6f
A proper send_string() for the Unicode feature (#8155) 2020-02-24 10:27:25 +11:00
Jez Cope
530c997638
Add link to "Useful functions" in macro docs (#7446)
* 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-23 12:50:11 -08:00
Akaash Suresh
b353028ea5
New functionality for cformat (#7893)
Fixing complexity

remove lambda

PR review fixes #1

Removing unneccesary string substitution

Handle -a and specified files

Complexity rewrite, use pathlib
2020-02-22 20:57:19 -08:00
Joel Challis
7707724dc4
Allow 30us matrix delay to be keyboard/user overridable (#8216)
* 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-21 14:49:33 +11:00
shela
58724f8dcb
[Docs] Update Japanese translation of cli.md (#8188) 2020-02-17 11:10:16 -08:00
shela
5e79da9f32
[Docs] Update Japanese translation (#8129)
* Update Japanese translation

* Update Japanese translation

Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
2020-02-17 01:03:49 -08:00
umi
bbe8180ad9
[Docs] add japanese translation (detail guide part) (#7722)
* 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-17 00:50:26 -08:00
Joel Challis
17ff551275
Convert f072 backlight build error to message (#8177) 2020-02-16 11:37:21 -08:00
Erovia
3ed1223678 Drop bs4 dependency, update docs, minor improvements 2020-02-15 15:19:03 -08:00
Erovia
26f53d38d9 Another major refactoring, add documentation
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-15 15:19:03 -08:00
Ted M Lin
9456832a3b
Fix out of bound OLED font access (#8145)
* 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 21:38:20 +00:00
ymzcdg
6a165c41cb
[Docs] doc update zh-cn (#8147)
* 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-11 10:05:23 -08:00
Joel Challis
fba9971555
Align max backlight level in docs (#8142) 2020-02-11 14:59:58 +00:00
Cody Bender
e77188458f
Add QMK Compile Context Sensitivity (#6884)
* 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-07 21:48:37 +01:00
fauxpark
a73c38112d
Move Grave Escape, Lock and Leader keycodes into their own sect… (#8093) 2020-02-07 15:54:14 +11:00
Joel Challis
307be48de9
Reduce SPLIT_USB_TIMEOUT by 500ms (#7637)
* Update SPLIT_USB_TIMEOUT -500ms

* Align keyboard level SPLIT_USB_TIMEOUT defaults

* Align keyboard level SPLIT_USB_TIMEOUT_POLL

* Review fixes
2020-02-04 19:37:04 -08:00
James Young
c096be3831
[Docs] future branch housekeeping 2020-02-01 21:36:59 -08:00
shela
ee88feb759 [Docs] Update Japanese translation (#8015) 2020-01-27 17:18:12 -08:00
James Young
72d7661b30 suggestions by skullydazed 2020-01-25 18:15:07 -08:00
James Young
d0d106cef7 change Instructions listing in Docs summary 2020-01-25 18:15:07 -08:00
James Young
d603e94f68 add Breaking Change PR Instructions doc 2020-01-25 18:15:07 -08:00
skullydazed
5e65af3a76 Beef up how qmk doctor works. (#7375)
* 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-24 20:31:16 +01:00
Nick Brassel
d13ada1162 Add customisable EEPROM driver selection (#7274)
- 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-24 12:45:58 +11:00
fauxpark
31c0fe69f6 [Docs] Misc cleanups for OLED documentation (#7864) 2020-01-19 14:05:54 -08:00
Rob Haswell
a1452db98a Configuration values for starting HSV and speed (#7740)
* 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-18 20:11:33 +00:00
Joel Challis
6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906)
* 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-18 12:56:33 +11:00
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