Commit Graph

1256 Commits (d02c4c5241b92396c883b9efa6f140236e74fa2d)

Author SHA1 Message Date
Ryan 92a787ca4c
[Docs] Use HTTPS for images and links where possible (#11695) 2021-01-30 22:00:56 +11:00
shela 5691f1341d
Update feature_debounce_type.md of Japanese document. (#10596)
* Update Japanese document.

* fix table format.

* fix heading

* Update translation

* Apply suggestions from code review

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

* Apply suggestions from code review

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

* Update docs/ja/feature_debounce_type.md

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

* Bump up comment tag

Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
2021-01-30 06:05:40 +09:00
Joshua Diamond bad9592a18
Add rgblight_reload_from_eeprom() (#11411)
* Add rgblight_reset_from_eeprom()

* reset->reload
2021-01-28 04:42:03 +11:00
glanchow 162842f16e
[Docs] add qmk setup home parameter (#11451) 2021-01-28 04:39:58 +11:00
David H. Bronke 92543a7cb5
fix(feature_ps2_mouse): fix Scroll Button example (#11669)
Corrected macro in Scroll Button example so it compiles.
2021-01-24 14:51:25 +00:00
Takeshi ISHII 944cf6476e
Update docs/getting_started_make_guide.md (#11373)
* update docs/getting_started_make_guide.md

Added description of some targets, including those added with #11338.

* Added description of options added by #11324.

* update docs/getting_started_make_guide.md

* Added description of  target.

* Update docs/getting_started_make_guide.md

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

* Update docs/getting_started_make_guide.md

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

* Update docs/getting_started_make_guide.md

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

* add ':id=linux-udev-rules' to docs/faq_build.md

Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
2021-01-24 15:15:11 +09:00
smiley d6701b3ac7
Fix typos and reword some sentences in FAQs (#11546)
* Fix minor typo in "General FAQ"

"want to do brand it with QMK" -> "want to brand it with QMK"

* Reword some of "Debugging FAQ" & "Miscellaneous FAQ".

Mostly grammatical wording of some parts and missing capitalization
2021-01-23 13:41:29 -08:00
Joel Challis 4e8166750b
Small tweaks to docs to make them more user friendly (#11518)
* first pass

* firmware firmware?

* Split out debug + testing docs

* tidy up duplicate css

* Add extra info to debug example

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

Co-authored-by: Drashna Jaelre <drashna@live.com>
2021-01-20 18:46:01 +00:00
Ryan eba512596a
Add stm32-dfu and apm32-dfu to bootloader.mk (#11019)
* Add stm32-dfu and apm32-dfu to bootloader.mk

* Update flashing docs

* Update comment

* Further wordsmithing
2021-01-20 14:04:21 +11:00
Joshua Diamond c0728bd189
Improve the Lighting Layers example in RGB Lighting docs (#11454)
* Improve the keymap layer state -> lighting layers example

* A few more improvements
2021-01-19 18:49:02 -08:00
Zach White d9785ec313
Improve the compile and flash subcommands (#11334)
* add support for --clean to compile and flash

* compile standalone JSON keymaps without polluting the tree

* Add support for passing environment vars to make

* make flake8 happy

* document changes to qmk compile and flash

* add -e support to json export compiling

* Fix python 3.6

* honor $MAKE

* add support for parallel builds
2021-01-16 15:13:04 -08:00
kb-elmo 3d70766327
Add BGR byte order for WS2812 drivers (#11562)
* add byte order bgr for ws2812

* update docs for driver change

* Update ws2812_driver.md

* Update docs/ws2812_driver.md

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

Co-authored-by: Ryan <fauxpark@gmail.com>
2021-01-16 08:42:30 +11:00
André Silva 345a041cf5
allow customizing decrease delay of rgb heatmap (#11322)
* allow customizing decrease delay of rgb heatmap

* rename rgb typing heatmap decrease delay variable

* address review comments

* nix-shell: add clang-tools required for formatting the C code

* heatmap: use real timer to track decrement rate

* heatmap: fix ifndef var name typo

* heatmap: add docs

* Update docs/feature_rgb_matrix.md

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

Co-authored-by: Drashna Jaelre <drashna@live.com>
2021-01-14 11:29:00 -08:00
Erovia b5c2e5e8fd
Fix documentation so UCIS example compiles. (#11541) 2021-01-14 11:11:59 +11:00
Nick Blyumberg 68b58624d6
[Docs] Update feature_rgblight.md (#11363)
* Update feature_rgblight.md

The note is meant to let people know that this is specific to RGB Backlight and does not work with RGB Matrix based implementations.

* Update docs/feature_rgblight.md

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

Co-authored-by: Drashna Jaelre <drashna@live.com>
2021-01-10 23:05:11 -08:00
L. K. Post efbaf68d5a
Fix documentation of `lsusb` behaviour (#10903) 2021-01-10 21:48:29 -08:00
Joshua Diamond 9d10c66cf0
Correct descriptions of rgblight functions (#11429) 2021-01-09 20:00:12 -08:00
Toban Wiebe 95a1496ebc
Fix AUR package name (#11416)
On Arch, `qmk` is now in the official repos, whereas only `qmk-git` is in AUR.
2021-01-09 11:37:42 +11:00
Joel Challis 6d9b4c7b4f
Suggest 'QMK MSYS' as the default windows platform (#11321)
* Suggest 'QMK MSYS' as the default windows platform

* Review comments
2021-01-08 11:09:28 -08:00
umi 340fc9dce3
[Docs] Japanese translation of feature_rawhid.md (#10858)
* add feature_rawhid.md translation

* update files based on comments

* update files based on comments

* update files based on comments
2021-01-06 14:08:21 +09:00
umi db8e88aae0
[Docs] Japanese translation of feature_led_indicators.md (#10960)
* add feature_led_indicators.md translation

* update related document

* add link on _summary
2021-01-06 14:07:07 +09:00
Michael Overman 988715910c
[Docs] Fix typo in hand_wire.md (#11297) 2021-01-01 17:36:17 -08:00
s-maurice 08fdf086b7
Fix typo in hand wiring guide (#11388)
ridid -> rigid
2021-01-01 14:57:02 +00:00
Ryan 10096fc42e
Zadig docs: add APM32 device name (#11356) 2020-12-30 16:35:06 +00:00
Reibl János Dániel 6f6e28b4c7
Add Arch / Manjaro section for Linux setup instructions (#10509) 2020-12-30 15:02:24 +01:00
André Cruz ca8df55858
Added mac variant of portuguese keymap extras (#11260)
* Added mac variant of portuguese keymap

This keymap is very similar to the existing portuguese keymap, but
some symbols are moved around.

Apply suggestions from code review

Corrected whitespace and implemented some suggested changes.

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

Converted some spaces to nbsp

Added sendstring ISO version

* Apply suggestions from code review

Added suggestions from code review

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

* Replaced space with nbsp

* Corrected 2 chars in ascii_to_shift_lut

{ and } require shift

Co-authored-by: Ryan <fauxpark@gmail.com>
2020-12-29 19:40:58 -08:00
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