James Young
72d7661b30
suggestions by skullydazed
5 years ago
James Young
d0d106cef7
change Instructions listing in Docs summary
5 years ago
James Young
d603e94f68
add Breaking Change PR Instructions doc
5 years ago
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>
5 years ago
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.
5 years ago
fauxpark
31c0fe69f6
[Docs] Misc cleanups for OLED documentation ( #7864 )
5 years ago
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.
5 years ago
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>
5 years ago
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>
5 years ago
skullY
58d27cf404
Add a note explaining how to run tests
5 years ago
skullY
44168baaa7
Add a section on python tests
5 years ago
fauxpark
c7b2d60a23
Move Space Cadet keycodes to their own section in keycode reference ( #7889 )
5 years ago
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
5 years ago
shela
5a02cc00a4
Fix docker script and document ( #7786 )
...
Fixed error when keyboard parameter is omitted in interactive mode.
5 years ago
James Young
71de09d751
Update Breaking Changes doc timeline
5 years ago
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.
5 years ago
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.
5 years ago
James Young
c1feeaa57f
Update Breaking Changes doc for 2020-02-29 merge
5 years ago
shela
6e520a721d
[Docs] fix installation commands for macos ( #7785 )
...
* [Docs] fix installation commands for macos
* Update docs/getting_started_build_tools.md
5 years ago
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>
5 years ago
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.
5 years ago
Casper Weiss Bang
dd04079098
Fixed a small typo ( #7743 )
5 years ago
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>
5 years ago
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
5 years ago
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>
5 years ago
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'.
5 years ago
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>
5 years ago
Takeshi ISHII
26a823082b
[Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md ( #7728 )
5 years ago
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>
5 years ago
fauxpark
b359830ea2
Fix file encoding for zh-cn/custom_quantum_functions.md ( #7665 )
5 years ago
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>
5 years ago
fauxpark
3c190f8927
Improve docs "Edit Document" footer
5 years ago
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>
5 years ago
Joel Challis
adb72b60b0
Merge pull request #7276 from zvecr/feature/backlight_driver_config
...
Convert backlight to follow driver rules pattern
5 years ago
Takeshi ISHII
b54722cc63
Change newbs.md to link to the new newbs_git_best_practices.md instead of newbs_best_practices.md. ( #7633 )
5 years ago
zvecr
3d54b1adf0
Convert backlight to follow driver rules pattern - update docs
5 years ago
umi
09c7304bd9
[Docs] update git command and directory name of documents ( #7619 )
5 years ago
Joel Challis
071eb2478f
Remove mbed files ( #7605 )
...
* Remove mbed files
* Remove mbed files - fix comment
* Remove mbed logic blocks
5 years ago
fauxpark
770a4ee729
[Docs] Remove some outdated FAQ items ( #7607 )
5 years ago
fauxpark
698d0dbda8
Use `clock_prescale_set()` from avr-libc ( #7540 )
...
* Use `clock_prescale_set()` from avr-libc
* Remove outdated FAQ info
5 years ago
Duncan Elliot
1af31a0523
Update feature support for Proton C ( #7596 )
...
Added a couple of entries for some features not currently supported on Proton C.
5 years ago
fauxpark
a8153774b5
[Docs] Fix docs fallback for pt-br ( #7602 )
5 years ago
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>
5 years ago
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>
5 years ago
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
5 years ago
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
5 years ago
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>
5 years ago
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>
5 years ago
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>
5 years ago
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
5 years ago