sporq/qmk-firmware
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
11,768 Commits 2 Branches 0 Tags
17ff5512757e05cd3b4e27066c24ac697fa8da9c
Commit Graph

843 Commits

Author SHA1 Message Date
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
Takeshi ISHII
b3b115bcc4 [Docs] Update check commands in Japanese documents (#7787) 
The Japanese documents included a sample command to check the original document changes. But there was something wrong, so I fixed it.
 2020-01-05 23:43:11 -08:00
James Young
c1feeaa57f Update Breaking Changes doc for 2020-02-29 merge 2020-01-04 12:24:51 -08:00
shela
6e520a721d [Docs] fix installation commands for macos (#7785) 
* [Docs] fix installation commands for macos

* Update docs/getting_started_build_tools.md
 2020-01-03 22:57:59 -08:00
shela
8b80cf853b [Docs] Update Japanese translation (#7783) 
* [Docs] Update translation

* Apply suggestions from code review

* Update docs/ja/config_options.md

* Update docs/ja/newbs_building_firmware.md

Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
 2020-01-03 22:57:03 -08:00
Takeshi ISHII
3fd8f160c3 [Docs] Added description of LIB_SRC to docs/config_options.md (#7765) 
And LINK_TIME_OPTIMIZATION_ENABLE move to 'Build Options' section.
 2020-01-02 14:47:27 -08:00
Casper Weiss Bang
dd04079098 Fixed a small typo (#7743) 2020-01-03 08:06:46 +11:00
umi
91013d452f [Docs] add japanese translation (faq part) (#7464) 
* add faq part

* add faq part

* add faq part

* add faq part

* add faq part

* update for link

* update for a punctuation

* update files based on comments

* restore removed git diff header

* correct pathname on git diff header

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

* update file based on comment

* update file based on comment

* update file based on comment

Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
Co-Authored-By: shela <shelaf@users.noreply.github.com>
Co-Authored-By: satt99 <39004890+satt99@users.noreply.github.com>
 2020-01-01 18:06:55 -08:00
Joel Challis
680ebef086 SPI DMA based RGB Underglow for STM32 (#7674) 
* Initial stash of ws2812 spi driver

* Update comment, add sync backup plan

* Add testing notes to spi ws2812 driver

* Align RGBW error messages
 2019-12-31 17:26:40 +00:00
Drashna Jaelre
a52e55ec09 [Docs] Update macOS related issues in docs (#7744) 
* [Docs] Update macOS related issues in docs

* Update faq_build.md

* Apply suggestions from code review

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

Co-authored-by: fauxpark <fauxpark@gmail.com>
 2019-12-31 14:33:54 +00:00
Takeshi ISHII
d1ed98f58b [Docs] remove docs/ja/newbs_best_practices.md (#7739) 
'docs/ja/newbs_best_practices.md' has been replaced by 'docs/ja/newbs_git_*.md'.
 2019-12-30 09:15:23 -08:00
Takeshi ISHII
25aaeb4f40 Japanese translation of docs/newbs_git_*.md (#7689) 
* update docs/ja/newbs.md

* update docs/ja/_summary.md

* Translate docs/newbs_git_best_practices.md into Japanese.

* Translate docs/newbs_git_using_your_master_branch.md into Japanese.

* Translate docs/newbs_git_resolving_merge_conflicts.md into Japanese.

* Translate docs/newbs_git_resynchronize_a_branch.md into Japanese.

* Update docs/ja/newbs_git_using_your_master_branch.md

* Update docs/ja/newbs_git_resynchronize_a_branch.md

* Update docs/ja/newbs_git_resynchronize_a_branch.md

* Update docs/ja/newbs_git_resynchronize_a_branch.md

* Update docs/ja/newbs_git_resynchronize_a_branch.md

* Update docs/ja/newbs_git_resynchronize_a_branch.md

* update ja/newbs_git_resynchronize_a_branch.md

* update ja/newbs_git_resynchronize_a_branch.md

* Update docs/ja/newbs_git_best_practices.md

* Update docs/ja/_summary.md

* Update docs/ja/newbs_git_resynchronize_a_branch.md

* update ja/newbs_git_resynchronize_a_branch.md

* update ja/newbs_learn_more_resources.md

* Update docs/ja/newbs_git_resynchronize_a_branch.md

* Update docs/ja/newbs_git_resynchronize_a_branch.md

Co-Authored-By: shela <shelaf@users.noreply.github.com>
 2019-12-28 23:38:33 -08:00
Takeshi ISHII
26a823082b [Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728) 2019-12-27 14:31:23 -08:00
shela
80e73b6210 [Docs] Update Japanese translation (#7693) 
* [Docs] Update translation

* Update docs/ja/contributing.md

* Update docs/ja/contributing.md

Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
 2019-12-27 12:09:32 -08:00
fauxpark
b359830ea2 Fix file encoding for zh-cn/custom_quantum_functions.md (#7665) 2019-12-27 03:31:48 +00:00
shela
52c18ef026 [Docs] fix docs (#7642) 
* [Docs] recurse-submodules option is need now

* [Docs] `tmk_core` folder is correct

* [Docs] fix typo

* [Docs] package scope has changed

* [Docs] Fix menu differences

* Update docs/arm_debugging.md

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

* Update docs/arm_debugging.md

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

* fix typo

Co-authored-by: fauxpark <fauxpark@gmail.com>
 2019-12-21 11:00:22 +00:00
fauxpark
3c190f8927 Improve docs "Edit Document" footer 2019-12-18 14:01:13 +11:00
umi
a860da8914 [Docs] add japanese translation (basic part) (#7461) 
* add basic part

* update cli

* update cli

* correct links to ja document

* update files based on comments

* update for a postpositional particle

* update for a punctuation

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

Co-Authored-By: shela <shelaf@users.noreply.github.com>
Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
 2019-12-16 21:01:46 -08:00
Joel Challis
adb72b60b0 Merge pull request #7276 from zvecr/feature/backlight_driver_config 
Convert backlight to follow driver rules pattern
 2019-12-16 16:39:54 +00:00
Takeshi ISHII
b54722cc63 Change newbs.md to link to the new newbs_git_best_practices.md instead of newbs_best_practices.md. (#7633) 2019-12-14 18:16:31 +00:00
zvecr
3d54b1adf0 Convert backlight to follow driver rules pattern - update docs 2019-12-14 03:25:06 +00:00
umi
09c7304bd9 [Docs] update git command and directory name of documents (#7619) 2019-12-12 20:59:00 -08:00
Joel Challis
071eb2478f Remove mbed files (#7605) 
* Remove mbed files

* Remove mbed files - fix comment

* Remove mbed logic blocks
 2019-12-11 11:36:00 -08:00
fauxpark
770a4ee729 [Docs] Remove some outdated FAQ items (#7607) 2019-12-11 11:33:09 -08:00