sporq/qmk-firmware
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
19,815 Commits 2 Branches 0 Tags
119cadbaae15585b5140c1102a49364fbcf7cd0d
Commit Graph

1864 Commits

Author SHA1 Message Date
Ryan
c21d5a0973 Refactor qmk_install.sh (#10681) 2020-11-26 14:37:54 +00:00
j-zero
078586b21a Update one_shot_keys.md (#10917) 
MOD_RSFT doesn't work. See: https://github.com/qmk/qmk_firmware/issues/10901
 2020-11-18 21:31:21 +00:00
Joel Challis
94e94ffb5b Recommend use of LED Indicator config (#10895) 
* Recommend use of LED Indicator config

* Recommend use of LED Indicator config - update link

* Update quantum/template/ps2avrgb/config.h

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

Co-authored-by: Ryan <fauxpark@gmail.com>
 2020-11-16 14:16:42 +11:00
Joel Challis
aae3b35c0f CI: Add docs build and deploy workflow (#7448) 
* Add docs build and deploy workflow

* Remove old travis docs workflow

* update to cli command

* Tidy up for review

* formatting

* Update to pass style checks

* Update lib/python/qmk/cli/docs.py

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

* Review comments - build->generate, use of verbose

* Add docs

* Update to match recent actions

* Run within base_container

* Convert cli to generate-docs

* Convert cli to generate-docs - restore old file

* Convert cli to generate-docs

* Update docs

Co-authored-by: skullydazed <skullydazed@users.noreply.github.com>
 2020-11-10 07:00:40 -08:00
elijahblake81
2ef68a84b6 Added color wheel that have QMK HSV values. (#8997) 
I've converted the 360 color wheel to the 255 color wheel for QMK HSV values.
 2020-11-10 15:57:43 +11:00
Mikkel Jeppesen
489bee0ee4 [Docs] redirect from /tutorial to /newbs (#10718) 
* Added redirect from /tutorial to /newbs

* Fixed indentation

* Changed title of tutorial page
 2020-11-09 20:33:15 -08:00
SeungheonOh
cb80b59e93 Adding few Korean translated files (#5895) 
* Korean Translation

Korean Translation

* Korean translation

* more Korean translations
 2020-11-10 06:11:04 +11:00
Joel Challis
1ff5ee255f Indicator LEDs as config (#10816) 
* First pass

* Add config options to docs

* Update some wording

* Slight tidy up of backlight caps logic

* Init pin to correct state

* Move init location

* Reverse default state
 2020-11-08 22:31:16 +00:00
Zach White
4d33d72975 New command: qmk lint (#10761) 
* Basic qmk lint command

* check for keymap readme

* change the workflow from qmk info to qmk lint

* add a strict mode

* parsing -> parse

* document qmk lint

* small info logging cleanup

* Apply suggestions from code review

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

* honor --strict in more places

* change the job name to lint

Co-authored-by: Ryan <fauxpark@gmail.com>
 2020-11-07 09:56:08 -08:00
Ryan
7ef98e7f61 CLI: Add qmk clean (#10785) 2020-11-04 19:18:47 +00:00
Ryan
5cecc1ea1e Add brightness level API to OLED driver (#10772) 
* Add brightness level API to OLED driver

* Set default brightness to 255
 2020-10-29 00:12:50 -07:00
Drashna Jaelre
40e694ea0d Add last breaking changes log to sidebar (#10680) 
Co-authored-by: Ryan <fauxpark@gmail.com>
 2020-10-18 15:46:47 +11:00
Morten Linderud
7d5ba88e6f 50-qmk.rules: Move udev rules from documentation into a file (#10664) 
This makes it overall easier to package for downstream distributions
instead of keeping tabs with inline documentation.

Signed-off-by: Morten Linderud <morten@linderud.pw>
 2020-10-17 20:30:18 +01:00
James Young
de68d294ec [Docs] add "Adding Default Keymaps to QMK Configurator" doc (#10049) 2020-10-18 03:50:32 +11:00
Ryan
f0a1ab5488 MSYS and WSL installation improvements (#10593) 2020-10-18 02:45:21 +11:00
shela
39c473a639 [Docs] Update feature_combo.md of Japanese document (#10671) 2020-10-17 03:19:06 -07:00
Andre Azzolini
139d28eaae [Docs] Add link to Tap-Hold Configuration Options from Mod-Tap (#10548) 2020-10-15 21:23:24 -07:00
shela
a2af0a352b Update other_vscode.md of Japanese document (#10604) 
* Update Japanese document

* Fix inline code

* Update docs/ja/other_vscode.md

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

Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
 2020-10-15 03:24:26 +09:00
shela
f706e1e80e Update Japanese document (#10607) 2020-10-14 05:09:59 +09:00
Takeshi ISHII
46c77febf7 [Docs] Japanese translation of docs/pr_checklist.md (#10415) 
* japanese translation of docs/pr_checklist.md

* update docs/ja/pr_checklist.md

* update docs/ja/pr_checklist.md

* update docs/ja/pr_checklist.md

* add :id=lite to docs/ja/custom_matrix.md

* add :id=... to docs/ja/custom_quantum_functions.md

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

* Update docs/ja/pr_checklist.md

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.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-10-14 05:08:26 +09:00
shela
b4e7d4ffae Update tags to check for document updates (#10606) 2020-10-13 17:03:17 +09:00
shela
4d59657b83 Fix typo within debounce documentation (#10600) 2020-10-13 01:46:16 +01:00
shela
3d9fff1d28 Update Japanese document (#10605) 2020-10-13 01:08:38 +09:00
shela
975c2422f3 Update Japanese document (#10601) 2020-10-13 01:07:59 +09:00
shela
a4efb55a39 Update Japanese document. (#10599) 2020-10-13 01:07:11 +09:00
shela
96ac448a0f Update feature_bluetooth.md of Japanese document. (#10594) 
* Update Japanese document.

* Left justified.

* Update docs/ja/feature_bluetooth.md

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

* Update docs/ja/feature_bluetooth.md

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

Co-authored-by: s-show <s1shimz@gmail.com>
Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
 2020-10-13 01:06:06 +09:00
shela
216f9ed2c1 Update Japanese document. (#10589) 2020-10-13 01:05:28 +09:00
shela
c66d65df58 Update Japanese document (#10603) 2020-10-13 01:02:52 +09:00
Takeshi ISHII
f7e5d712c2 [Docs] Japanese translation of docs/isp_flashing_guide.md (#9896) 
* start translation docs/ja/isp_flashing_guide.md

* Japanese translation is in progress.

* Japanese translation is in progress.

* Japanese translation is in progress.

* Japanese translation is in progress.

* Japanese translation is in progress.

* Japanese translation is in progress.

* Japanese translation is in progress.

* update docs/ja/isp_flashing_guide.md

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

Co-authored-by: Takuya Urakawa <urkwtky@gmail.com>

* Update docs/ja/isp_flashing_guide.md

Co-authored-by: Takuya Urakawa <urkwtky@gmail.com>

* Update docs/ja/isp_flashing_guide.md

Co-authored-by: Takuya Urakawa <urkwtky@gmail.com>

* Update docs/ja/isp_flashing_guide.md

Co-authored-by: Takuya Urakawa <urkwtky@gmail.com>

Co-authored-by: shela <shelaf@users.noreply.github.com>
Co-authored-by: Takuya Urakawa <urkwtky@gmail.com>
 2020-10-13 01:01:07 +09:00
Jan-Frederick Musiol
49abff9071 changed type of process_combo_event argument in tutorial (#10621) 
in tutorial for combos feature, changed type of compo_index argument of process_combo_event form uint8_t to uint16_t
 2020-10-13 02:14:37 +11:00
shela
a88cfa395b Update feature_backlight.md of Japanese document. (#10592) 
* Update Japanese document.

* Update tag
 2020-10-10 18:16:32 +09:00
shela
6e78655e17 Update Japanese document. (#10591) 2020-10-10 18:15:22 +09:00
shela
b0c8cbe462 Update Japanese document. (#10590) 2020-10-10 18:12:04 +09:00
shela
962adbea3a Update Japanese document. (#10588) 2020-10-10 18:00:11 +09:00
Erovia
a67b32425b Docs: fix udev rules 
Apparently, udev does not like inline comments.
Rules with them are ignored, oops.
 2020-10-06 17:29:47 -07:00
Erovia
058737f116 [CLI] Add c2json (#8817) 
* Basic keymap parsing finally works

* Add 'keymap.json' creation to the qmk.keymap module

* Add tests and fix formatting

* Fix/exclude flake8 errors

* Convert keymap.c to valid keymap.json

* Fix some errors

* Add tests

* Finalize keymap.json creation, add json template

* Add docs

* Move pygments to the standard requirements

* Add support for nameless layers, fix tests

* Fix things after rebase

* Add missing 'keymap' value.

* Fix missing layer numbers from advanced keycodes

Buckwich noticed that if the advanced keycode / layer toggling key
contains a number, it goes missing.
Now we properly handle them.
Thx for noticing!

* Apply suggestions from code review

* fixup tests

Co-authored-by: Zach White <skullydazed@drpepper.org>
Co-authored-by: skullY <skullydazed@gmail.com>
 2020-10-06 17:10:19 -07:00
Joe Strong
2013f63134 Fixes small typo in docs (#10515) 2020-10-05 19:21:39 +11:00
George Mao
9e9b604234 Mark 'key_count' as optional within info.json docs (#10513) 
* Update reference_info_json.md

key_count is now an optional field because it is better to get the keycount by counting the elements in the layout array.

* Updated Japanese documentation as well
 2020-10-03 00:42:11 +01:00
nopunin10did
0cb7133e0d Doc followup 9942 (#10473) 
* Update feature_advanced_keycodes.md

* Update mod_tap.md
 2020-10-01 22:19:57 +01:00
Ryan
e7acd39b78 Consolidate udev rules into a single file (#9693) 
* Consolidate udev rules into a single file

* Update rules in doctor.py

* Simplify doctor rule checking

* Fix errors

* Add TMK "FEED" VID to list of deprecated udev rules

* A comma would be nice

* Split rules back up into bootloaders

* Link to docs page in "missing" case

* Add Pololu VID

* Be more specific about Caterina devices, and add LilyPad PID
 2020-09-27 20:36:33 +10:00
precondition
28ff51175b [Docs] Wording & formatting changes in the Tapping Force Hold section of the Tap Hold page + removed trailing whitespaces (#10391) 
* Wording & formatting changes in Tapping Force Hold

The Permissive Hold and the Ignore Mod Tap Interrupt sections were also modified to remove the quotes
around "tapping".

* Removed all trailing whitespaces from tap hold doc

* "it's simply really:" → "it's simple really:"

* "This allows to keep the ability" → "This allows keeping the ability"

Used the gerund form of "to keep" in the Tapping Force Hold section of the Tap Hold docs.

Co-authored-by: ridingqwerty <george.g.koenig@gmail.com>

Co-authored-by: ridingqwerty <george.g.koenig@gmail.com>
 2020-09-26 19:11:40 -04:00
umi
4bf5f9424e [Docs] Japanese translation of docs/understanding_qmk.md (#10136) 
* add understanding_qmk.md translation

* update based on comment

* update based on comment

* update based on comment

* update based on comment

* update based on comment
 2020-09-22 14:54:33 -07:00
Peter Landoll
0fbb1e550a Add description in Bluetooth docs for requiring NKRO to be disabled (#10359) 2020-09-22 22:31:37 +10:00
Fred Silberberg
c23667608c Add OLED driver function to determine if the screen is currently on (#10382) 2020-09-21 18:39:50 -07:00
Dustin Bosveld
2f637e4ea1 [Docs] Clarify functionality of update_tri_layer_state (#10370) 
* Add information to docs
- If layer z is not a higher layer than both x and y, the layer change code
does not function correctly.

* Update docs/ref_functions.md

* Update docs/ref_functions.md

* Update docs/ref_functions.md
 2020-09-21 11:35:26 -07:00
fauxpark
a0305f5e7e Be more specific about Caterina devices, and add LilyPad PID 2020-09-19 05:40:25 +10:00
fauxpark
c2a0cebf8b Add Pololu VID 2020-09-19 05:21:33 +10:00
fauxpark
72b1ff5899 Add TMK "FEED" VID to list of deprecated udev rules 2020-09-19 05:21:31 +10:00
fauxpark
07e37c857c Update rules in doctor.py 2020-09-19 05:21:30 +10:00
fauxpark
a21e487fbc Consolidate udev rules into a single file 2020-09-19 05:21:29 +10:00