Commit graph

1230 commits

Author SHA1 Message Date
Ryan
962b8d3814
Update keycode docs (#11343) 2020-12-30 07:51:36 +11:00
Ryan
122cf3ad0f
Update Zadig docs with list of bootloader device names and IDs (#11337) 2020-12-29 19:46:15 +00:00
Chas
3300164065
Typo fix: Useful function -> Useful Functions (#11342)
Thanks!
2020-12-30 01:32:30 +09:00
Ryan
1b7b72c0e9
Ensure single newline at EOF for core files (#11310) 2020-12-28 04:36:32 +11:00
Joel Challis
bbf0f65284
Simplify the visual flow of the getting started page (#11316)
* Add tabs to getting started page

* Review comments

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

* Align with current theme

* Update docs/newbs_getting_started.md

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

* Apply suggestions from code review

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

Co-authored-by: Ryan <fauxpark@gmail.com>
2020-12-27 16:56:10 +00:00
Boris Faure
9136c122f8
docs: add Gentoo to newbs_getting_started.md (#11241) 2020-12-23 17:59:57 +01:00
Nick Blyumberg
b2ab0af905
[Docs] Update links in main README.md (#11284)
It looks like features.md was deprecated and content was split into other files. This results in a broken link on the main page which, if removed, would have no impact to the remainder of the documentation. This would also:
resolve #9239
resolve #10293 
resolve #10447
2020-12-22 22:37:01 -08:00
Daniele De Vincenti
498d89f4b3
[Docs] Add clarification on use of custom RGB Matrix effect (#11176)
* Update feature_rgb_matrix.md

Added more clarification on how to use a newly created rgb effect as it was unclear that the prefix 'RGB_MATRIX_CUSTOM_' had to be added.
Also included an example consistent with the documentation example.

* Update docs/feature_rgb_matrix.md

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

* Update docs/feature_rgb_matrix.md

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

Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Joel Challis <git@zvecr.com>
2020-12-22 21:59:26 -08:00
Kishor Prins
dee506c096
Updated Raw HID docs to clarify packet/report length (#11211)
Co-authored-by: Ryan <fauxpark@gmail.com>
2020-12-23 08:04:55 +11:00
precondition
6890090fbb
Updated usage of qmk c2json (#11148) 2020-12-18 21:56:23 +01:00
Ryan
37fb14f1b5
CLI-ify rgblight_breathing_table_calc.c (#11174)
Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
Co-authored-by: Zach White <skullydazed@drpepper.org>
2020-12-16 14:24:42 +11:00
Xelus22
70f40339c2
Add i2c 24LC64 eeprom (#11200)
* add 24LC64 eeprom

* docs update

* Update docs/eeprom_driver.md

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

Co-authored-by: Joel Challis <git@zvecr.com>
2020-12-14 05:50:50 +11:00
Ryan
501f2fdef1
Normalise include statements in core code (#11153)
* Normalise include statements in core code

* Missed one
2020-12-11 13:45:24 +11:00
Josh Hinnebusch
c59f87a5d7
add definition WS2812_BYTE_ORDER to fix RGB LED issues (#10184)
* add define for WS2812B-2020 to fix RGB issues

* update driver doc

* add WS2812_BYTE_ORDER definition to correct RGB byte issues

* add definition variable thing

* update per PR request

* update per PR reqs

* update per PR request

* inital changes

* move defines to color.h and add rgbw incase

* Update docs/ws2812_driver.md

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

Co-authored-by: hineybush <hineybushkeyboards@gmail.com>
Co-authored-by: Xelus22 <preyas22@gmail.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
2020-12-06 17:15:48 +11:00
James Young
c66df16644
2020 November 28 Breaking Changes Update (#11053)
* Branch point for 2020 November 28 Breaking Change                                                

* Remove matrix_col_t to allow MATRIX_ROWS > 32 (#10183)                                           

* Add support for soft serial to ATmega32U2 (#10204)                                               

* Change MIDI velocity implementation to allow direct control of velocity value (#9940)            

* Add ability to build a subset of all keyboards based on platform.                                

* Actually use eeprom_driver_init().                                                               

* Make bootloader_jump weak for ChibiOS. (#10417)                                                  

* Joystick 16-bit support (#10439)                                                                 

* Per-encoder resolutions (#10259)                                                                 

* Share button state from mousekey to pointing_device (#10179)                                     

* Add hotfix for chibios keyboards not wake (#10088)                                               

* Add advanced/efficient RGB Matrix Indicators (#8564)                                             

* Naming change.                                                                                   

* Support for STM32 GPIOF,G,H,I,J,K (#10206)                                                       

* Add milc as a dependency and remove the installed milc (#10563)                                  

* ChibiOS upgrade: early init conversions (#10214)                                                 

* ChibiOS upgrade: configuration file migrator (#9952)                                             

* Haptic and solenoid cleanup (#9700)                                                              

* XD75 cleanup (#10524)                                                                            

* OLED display update interval support (#10388)                                                    

* Add definition based on currently-selected serial driver. (#10716)                               

* New feature: Retro Tapping per key (#10622)                                                      

* Allow for modification of output RGB values when using rgblight/rgb_matrix. (#10638)             

* Add housekeeping task callbacks so that keyboards/keymaps are capable of executing code for each main loop iteration. (#10530)

* Rescale both ChibiOS and AVR backlighting.                                                       

* Reduce Helix keyboard build variation (#8669)                                                    

* Minor change to behavior allowing display updates to continue between task ticks (#10750)        

* Some GPIO manipulations in matrix.c change to atomic. (#10491)                                   

* qmk cformat (#10767)                                                                             

* [Keyboard] Update the Speedo firmware for v3.0 (#10657)                                          

* Maartenwut/Maarten namechange to evyd13/Evy (#10274)                                             

* [quantum] combine repeated lines of code (#10837)                                                

* Add step sequencer feature (#9703)                                                               

* aeboards/ext65 refactor (#10820)                                                                 

* Refactor xelus/dawn60 for Rev2 later (#10584)                                                    

* add DEBUG_MATRIX_SCAN_RATE_ENABLE to common_features.mk (#10824)                                 

* [Core] Added `add_oneshot_mods` & `del_oneshot_mods` (#10549)                                    

* update chibios os usb for the otg driver (#8893)                                                 

* Remove HD44780 References, Part 4 (#10735)                                                       

* [Keyboard] Add Valor FRL TKL (+refactor) (#10512)                                                

* Fix cursor position bug in oled_write_raw functions (#10800)                                     

* Fixup version.h writing when using SKIP_VERSION=yes (#10972)                                     

* Allow for certain code in the codebase assuming length of string. (#10974)                       

* Add AT90USB support for serial.c (#10706)                                                        

* Auto shift: support repeats and early registration (#9826)                                       

* Rename ledmatrix.h to match .c file (#7949)                                                      

* Split RGB_MATRIX_ENABLE into _ENABLE and _DRIVER (#10231)                                        

* Split LED_MATRIX_ENABLE into _ENABLE and _DRIVER (#10840)                                        

* Merge point for 2020 Nov 28 Breaking Change
2020-11-28 12:02:18 -08:00
Drashna Jaelre
16d55b14b7
[Docs] Add VBUS hack for teensys (#10986) 2020-11-27 21:03:31 -08:00
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