Commit graph

638 commits

Author SHA1 Message Date
noroadsleft
4211252117 [Docs] Fix indented subheading on faq_debug.md (#6320) 2019-07-13 13:33:44 -07:00
Phil Schalm
663ca6ba9d Documentation: Newbs Flashing: Hightlight that sudo may be needed (#6300)
* Hightlight that sudo may be needed

Also added "dfu-programmer: no device present" in so that anyone searching for that particular error can hopefully find the page.

* Use new style of indicating a warning

* Indicate that the FAQ should be read instead of blindly using sudo
2019-07-12 05:42:21 -07:00
fauxpark
ecf0612cc8 [Docs] Clarify the rules.mk setup for Unicode (#6286)
* Clarify the rules.mk setup for Unicode

* code point

Co-Authored-By: Konstantin Đorđević <vomindoraan@gmail.com>

* Remove "your"

Co-Authored-By: Konstantin Đorđević <vomindoraan@gmail.com>

* Undo a line change

Co-Authored-By: Konstantin Đorđević <vomindoraan@gmail.com>

* dot the comma

Co-Authored-By: Konstantin Đorđević <vomindoraan@gmail.com>

* Update docs/feature_unicode.md

Co-Authored-By: Konstantin Đorđević <vomindoraan@gmail.com>
2019-07-11 11:33:55 -07:00
XScorpion2
6e6d079dd2 Updated OLED Docs with notes about screen timeout. (#6276)
* Updated OLED Docs with notes about screen timeout.

* Update docs/feature_oled_driver.md

Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
2019-07-08 06:28:31 -07:00
XScorpion2
d16db69367 Added mod carry over from press to release. (#5866)
Update docs/feature_space_cadet.md

Co-Authored-By: fauxpark <fauxpark@gmail.com>
2019-07-06 21:00:05 -07:00
shela
c1c0cf73ce fix typo 2019-07-01 15:32:59 +09:00
lf
1a442f9989 [Docs] Reword confusing description of TO(layer) (#6174)
* Reword confusing description of `TO(layer)`

* Update docs/keycodes.md

Co-Authored-By: Drashna Jaelre <drashna@live.com>
2019-06-24 00:23:27 -07:00
fauxpark
317b809564 Fix breathing always on for soft PWM (#5983)
* Fix breathing always on for soft PWM

* Remove reference to hardware PWM pins in BACKLIGHT_BREATHING description

Now, breathing will only be unsupported when Timers 1 and 3 are both used by Audio

* Document BACKLIGHT_ON_STATE and its purpose
2019-06-19 22:33:39 -07:00
Danny
810c8db770 Set default I2C clock speed to 100kHz for split_common (#6161)
* Set default I2C clock rate for split_common boards to 100kHz

Default from I2C driver is 400kHz.

* Update documentation for setting I2C clock speed
2019-06-19 22:02:20 -07:00
fauxpark
6bdcbfb25a Fix backlight breathing on C6 (#6102)
* Fix backlight breathing on C6

* Account for ATmega32A's single TIMSK register (MT40)

* Document hardware PWM on D4 for ATmega32A

* Add C6 and D4 to BACKLIGHT_PIN description
2019-06-17 19:37:17 -07:00
Michael F. Lamb
e6a81133dd Add SH1106 OLED support (#5787)
* modify oled_driver to support SH1106

also:
- improve mechanism to specify which OLED IC we use
- comment calc_bounds()
- give OLED_COLUMN_OFFSET a default value
- inline comment re: OLED MEMORY_MODE and SH1106
- update docs/feature_oled_driver.h for SH1106 support and related changes
- docs: OLED: note we have tested SSD1306 on ARM boards (per @XScorpion2)
- define out MEMORY_MODE when using SH1106 OLED driver

* document that SSD1306 128x64 on AVR works

Per @XScorpion2: https://github.com/qmk/qmk_firmware/pull/5787#discussion_r291837842
2019-06-11 15:27:17 -07:00
Chris Scheib
bba5c09b23 [Docs] Update feature_rgb_matrix.md (#6117)
* Update feature_rgb_matrix.md

fix indentation on code comments

* Update feature_rgb_matrix.md

more formatting changes, missed these the first time
2019-06-11 14:42:53 -07:00
XScorpion2
09968ba035 Fixing OLED Driver for 128x64 displays (#6085) 2019-06-07 17:02:05 -07:00
Drashna Jaelre
faaaa134fd Replace DEBOUNCING_DELAY (deprecated) with DEBOUNCE (#5997) 2019-06-06 12:09:56 -07:00
Jack Humbert
fe6b8edd58
use twitter card large setting for larger previews 2019-06-06 01:23:18 -04:00
Jack Humbert
834a8d1da1
add type:object to docs meta info (github uses it) 2019-06-06 01:07:54 -04:00
Jack Humbert
91b0c75045
Add meta tags for docs 2019-06-06 01:01:24 -04:00
Danny Nguyen
4f2f2271cd Change from avr-gcc@7 to @8 for Mac 2019-06-05 17:51:39 -07:00
Alex Mayer
b2f7915994 [Docs] Make Code Examples Consistent On Combo Page (#6078) 2019-06-05 11:18:20 -07:00
ymzcdg
e0a0d80bd3 docs to Mandarin Chinese (#5960)
* faq_general.md to Chinese

faq_general.md to Chinese
faq finished

* custom_quantum_functions.md to Chinese

custom_quantum_functions.md to Chinese

* custom_quantum_functions.md fix 

custom_quantum_functions.md fix

* custom_quantum_functions.md fix translate 

custom_quantum_functions.md fix translate

* !ver.English! _summary.md bug fix

 _summary.md bug fix of English doc. add".md" behind "feature_combo"

* !ver.English! custom_quantum_functions.md fix#5869

custom_quantum_functions.md in English : delete redundant "is" . issue#5869

* !ver.English! how_keyboards_work.md link fix

change 
https://en.wikipedia.org/wiki/Unicode_input#Hexadecimal_code_input
to 
https://en.wikipedia.org/wiki/Unicode_input#Hexadecimal_input
"#Hexadecimal_code_input" not exist

* !English! how_keyboards_work.md add missing "t"

Tied to a specific OS a a time (need recompilation when changing OS);
change to
Tied to a specific OS at a time (need recompilation when changing OS);

* _summary.md improve translation

_summary.md improve translation

* reference_glossary.md into Chinese

reference_glossary.md into Chinese
术语表翻译,这个术语表英文版似乎不太全,应该补充英文版,并在中文版添加其他具有中国特色的术语。
2019-06-04 11:06:17 -07:00
Jack Humbert
661a9154ae
Add missing links to features page and sidebar section (#5949)
* Add missing links to features page and sidebar section

* Fix links

Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>

* Additional link fixes

Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>

* Fix typo
2019-06-04 02:26:44 -04:00
Nick Brassel
155be34a1d Parameterise STM32 I2C pin modes and timing parameters. (#5671)
I2C timing parameters were seemingly set up for an STM32F303 target MCU, at a specific clock speed. This commit allows specifying the timing parameters via config.h, allowing other STM32 MCUs to be targeted, potentially at different clock frequencies.
Alternate function modes for the I2C pins are now also configurable, allowing for remapping to other pins.
2019-06-01 16:04:09 -07:00
Elliot Powell
d3317a8a66 [Docs] Update getting_started_introduction.md (#6037)
* Update getting_started_introduction.md

* Update docs/getting_started_introduction.md

Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>

* Update docs/getting_started_introduction.md

Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>

* Update docs/getting_started_introduction.md

Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>

* Update docs/getting_started_introduction.md

Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
2019-05-31 14:44:27 -07:00
Elliot Powell
9cc5841a91 Update reference_configurator_support.md
We no longer auto generate bootloader into info.json through the website therefore this can be removed
2019-05-31 11:54:01 -07:00
Elliot Powell
3ef425423a Update feature_encoders.md
Fix missing closing comment after second encoder
2019-05-30 17:00:21 -07:00
fauxpark
fe8c2209ca Document MT keycode in keycodes.md 2019-05-25 09:10:52 -07:00
Drashna Jaelre
36f427f40c
Fix typo 2019-05-23 10:29:18 -07:00
Drashna Jaelre
c97315dc5a
Additional link fixes
Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
2019-05-22 21:00:20 -07:00
Drashna Jaelre
dcb274b286
Fix links
Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
2019-05-22 20:55:52 -07:00
ymzcdg
894010786c translate docs into Mandarin Chinese (#5890)
* translate docs into Mandarin Chinese

translate
faq_debug.md
into Chinese

* translate faq_build.md into Chinese

translate faq_build.md into Chinese

* faq_keymap.md to zh-cn

faq_keymap.md to zh-cn
2019-05-22 14:33:10 -07:00
Drashna Jaelre
02787ac07f
Add missing links to features page and sidebar section 2019-05-21 13:15:59 -07:00
Ryan Caltabiano
5c7b37bbbd Added custom center point to rgb matrix 2019-05-19 09:38:38 -07:00
XScorpion2
270b39b2eb Spirals, Pinwheels, and Documentation....Oh My! RGB Matrix Effects (#5877)
* Spirals, Pinwheels, and Documentation....Oh My!

* Spiral effect band thickness adjustments

* Fixing animation spin directions
2019-05-19 09:19:46 -07:00
XScorpion2
0099bbf9a6 Single Color Band scrolling left to right effects (#5867) 2019-05-19 09:09:06 -07:00
Josh
d85110b6ec Adds a configurable initial delay to the audio clicky feature (#4286)
* Adding an AUDIO_CLICKY_DELAY_DURATION configurable value to the AUDIO_CLICKY feature.

* Tweaking my community keymap to work better with my rev 4 planck.
2019-05-17 13:48:53 -07:00
Drashna Jaelre
48b01446ba Make delay for Capslock in Hold-Tap functions configurable (#5497)
* Increase delay for Hold-Tap register for CAPSLOCK

Because it seems that the 80ms delay wasn't too much

* Screw it, make the caps delay a define and make it configurable
2019-05-16 10:28:06 -07:00
Pavlos Vinieratos
b541369c45 [Docs] Fix typo in Userspace doc (#5871)
* typo

* Update docs/feature_userspace.md

Co-Authored-By: fauxpark <fauxpark@gmail.com>
2019-05-16 08:21:51 -07:00
Takeshi ISHII
670a9b7f83 Add effect range to rgblight.c (#5856)
* add rgblight_set_effect_range()

* implement effect range

* Arrange the order of function list in rgblight.h .

* update docs/feature_rgblight.md

* fix RGBLIGHT_RAINBOW_SWIRL_RANGE default value

* add example code about Utility Functions

* add example code about direct operation functions

* When RGBLIGHT_SPLIT is defined, the following function has no meaning and is invalidated.

 * rgblight_setrgb_master(r, g, b)
 * rgblight_setrgb_slave(r, g, b)
 * rgblight_sethsv_master(h, s, v)
 * rgblight_sethsv_slave(h, s, v)

* add temporary test code for rgblight_set_effect_range

* fix rgblight_effect_knight() bug

* Test End. Revert "add temporary test code for rgblight_set_effect_range"

This reverts commit 5680cddd012d68b2db75a532862a7fef250f8973.
2019-05-15 21:11:28 -07:00
XScorpion2
c6184d2e7e Added check for event pressed to clear space cadet (#5839)
* Added check for pressed to clear space cadet

* Found some docs to update

* Update docs/quantum_keycodes.md

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

* Changes from PR
2019-05-11 22:20:14 -07:00
ymzcdg
7871a465d3 translate docs into Mandarin Chinese (#5807)
* translate newbs.md into Madarin Chinese

translate newbs.md into Madarin Chinese

* translate docs into Mandarin Chinese

translate getting_started_github.md into Mandarin Chinese

* translate getting_started_getting_help.md into Mandarin Chinese

translate getting_started_getting_help.md into Mandarin Chinese

* contributing.md to Chinese

Personify QMK as a girl named Q酱 . It can make more developer read this document and contribute QMK.

* getting_started_introduction.md to Chinese

getting_started_introduction.md to Chinese

* faq.md to Chinese

faq.md to Chinese

* crlf2lf getting_started_introduction.md

ending line fix getting_started_introduction.md

* crlf2lf contributing.md

crlf2lf contributing.md
2019-05-11 09:22:16 -07:00
XScorpion2
fd23a0e909 RGB Matrix Effects: Cycle Out to In & Cycle Out to In Dual (#5812) 2019-05-10 19:56:16 -07:00
XScorpion2
62ba66d618 Cleanup/rgb matrix (#5811)
* clean up rgb matrix extern usage

Moved rgb matrix boiler plate into macros

Rebased onto typing heatmap pr

* Fixing the reversed frame buffer access in digital rain

* Fixing digital rain & typing heatmap if keyreactive effects are not enabled

* Apply suggestions from code review

Co-Authored-By: Drashna Jaelre <drashna@live.com>

* Adding parenthesizes to DRIVER_LED_TOTAL where necessary

* Updated docs

* added notes about parentheses
2019-05-10 16:55:02 -07:00
Yan-Fa Li
febaf9dec4 [Docs] RGB Animation documentation on reducing memory footprint (#5813)
* Improve Animation docs with example

 - example to reduce flash footprint of animations using RGBLIGHT_EFFECT_ defines

* Re-order the effects list

* Update docs/feature_rgblight.md

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

* Update docs/feature_rgblight.md

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

* Update docs/feature_rgblight.md

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

* Introduce line breaks

* Add title for animation speed section

* Organize Animation Defines Into Groups

* Use the RGB EFFECT recommended by mtei in docs

 - has the most modes, and STATIC_LIGHT can't really be disabled.

* Use more accurate titles for effects and animation

 - accidentally put a toggle in settings
2019-05-10 09:50:52 -07:00
Tobias V. Langhoff
16f367348a [Docs] Fix Space Cadet link (#5825)
Fix broken Space Cadet link in Features list
2019-05-08 21:45:00 -07:00
XScorpion2
60eae7335b RGB Matrix Typing Heatmap (#5786)
* RGB Matrix Typing Heatmap Effect

* Fixing file name and effect init
2019-05-07 19:17:00 -07:00
XScorpion2
af89752bff rgb_led struct conversion (aka: Per led (key) type rgb matrix effects - part 2) (#5783)
* Initial conversion of the rgb_led struct

* Converting last keyboard & updating effects to take advantage of the new structure

* New struct should not be const

* Updated docs

* Changing define ___ for no led to NO_LED

* Missed converting some keymap usages of the old struct layout
2019-05-07 16:22:46 -07:00
XScorpion2
e290dc5ad8 Space Cadet: Reducing unnecessary reported keypresses (#5781)
* Reducing unnecessary reported keypresses and minor docs / variable name changes

* Apply suggestions from code review

Co-Authored-By: XScorpion2 <rcalt2vt@gmail.com>
2019-05-05 16:27:02 -07:00
Ryan Caltabiano
3a7c65b424 fix line endings 2019-05-04 10:17:46 -07:00
Jez Cope
9d97e47df4 [Docs] Update Super ALT↯TAB to remove use of unregister_code16 (#5766)
The code as originally listed didn't work for me, but replacing `unregister_code16(LALT(KC_TAB));` with `unregister_code(KC_LALT);` fixes the problem and causes the macro to work as intended.

Thanks to folks on Discord for helping me figure this out.
2019-05-04 09:46:44 -07:00
zvecr
da995d2aea [Docs] Add examples to debugging docs (#5555)
* Add examples to debugging docs

* Add examples to debugging docs - review comments

* Update matrix keypress example to use uprintf
2019-05-03 17:24:07 -07:00