331288233d
Add rgblist to docs
2018-03-28 16:55:58 -04:00
ae7284edb8
rename api docs to internals
2018-03-26 11:43:37 -07:00
ee1bb85542
Expand Newb Guide flashing document ( #2588 )
...
* Add header info
* Add DFU section
* Add Caterina section
* Add Halfkay section
* Fix Typos
* More typos
2018-03-26 13:34:18 -04:00
07b90db897
Fixes and updates to docs ( #2611 )
...
* Fix advanced keycode headers
* Add caveat for OSM over Remote Desktop
* Hopefully add better anchors to docs
* Add Action code list reference
* Formatting of RGB Underglow doc
* Add brew update issue on macOS
* Revert formatting
* Revert RGB doc formatting
* Make Config Options doc's sections linkable
2018-03-25 16:44:17 -07:00
d965d72d4a
Fix custom functions documation for layer_state_set*
2018-03-24 12:49:56 -04:00
3ee59a79aa
Add HSV value specification ( #2481 )
...
* Update feature_rgblight.md
I got caught out with this as most color pickers use a percentage NOT 0-255 for this number
* Amended description
Woops! Was focused on s/v not being a percentage i got h wrong.
2018-03-23 16:10:32 -07:00
d0054c41e2
Fix typo in autoshift docs: statn ( #2579 )
2018-03-23 16:03:19 -07:00
7c9d5ace14
Generate API docs from source code comments ( #2491 )
...
* Generate api docs from source code
* Add a bunch of doxygen comments
* more doxygen comments
* Add the in-progress api docs
* script to generate docs from travis
* Add doc generation to the travis job
* make travis_docs.sh commit the work it does
* make sure the docs script exits cleanly
2018-03-22 02:50:38 -04:00
7a5ce36f23
Add macro for momentarily switching to a layer while some mods are active ( #2460 )
...
* Macro for a momentary layer switch with mods
Passes through to the existing ACTION_LAYER_MODS macro, albeit with more
limited options due to lack of space in the quantum_keycodes enum.
* Add documentation for LM layer-mod macro
* Clean up Tap Toggle documentation
2018-03-20 22:59:54 -04:00
6d66fe0c0c
Added bootloader options
...
I think I got all of them, so I removed the "FIXME".
2018-03-20 11:47:22 -04:00
ff728a8a01
[Proposal?] Allow RGB Underglow to turn off when host is idle/asleep ( #2104 )
...
* Add RGB Underglow Sleeping
* Add RGBLIGHT_SLEEP to toggle/control RGB light behavior
* Update rgb docs
* Update for RGB disable command
2018-03-19 23:59:58 -04:00
00b4dce605
Rule to enable Modifiers with Auto-Shift ( #2542 )
...
* Re-enable modifiers with auto-shift
* Auto-shift modifiers rule
* missed a line
* Documentation
* fixing whitespace
2018-03-16 16:41:01 -04:00
a2e12faa19
Add CMD and WIN aliases for KC_GUI, GUI(kc), GUI_T(kc), etc.
2018-03-16 16:37:44 -04:00
23ac2a02ef
Add keycodes for swap-hands feature.
2018-03-16 16:33:43 -04:00
7230923b05
Rename ONEHAND_ENABLE to SWAP_HANDS_ENABLE for consistency
2018-03-16 16:33:43 -04:00
3f1d147529
Add SS_RALT for AltGR usage in macros
2018-03-09 13:15:10 -05:00
566399794a
Disable the glossary linking to fix #2498 ( #2499 )
2018-03-08 10:31:08 -08:00
42e85d2b92
Add layer_state_set_* to custom function lists
2018-03-07 17:05:38 -05:00
d27d854913
Examples should all use _user functions for consistency
2018-03-07 17:05:38 -05:00
7b80aea8b2
Add back docs for hand-swapping feature.
2018-03-07 16:56:57 -05:00
48e11240a6
Move the linux tutorials to an info box on newbs_getting_started
2018-03-06 20:51:26 -08:00
75354f12d7
warn->danger
2018-03-06 15:39:46 -08:00
6a4e08938e
Flesh out the newbs guide
2018-03-06 15:22:47 -08:00
08e48eb6f5
Add a newbie guide for people completely new to QMK ( #2480 )
2018-03-06 14:37:48 -08:00
b36b4382d0
Mention invalid names in the readme. ( #2458 )
2018-03-03 09:52:09 -08:00
e87c39d302
More thoroughly document Bootmagic and Command ( #2455 )
2018-03-02 09:21:03 -08:00
31cae1f1bd
Update feature_macros.md ( #2387 )
...
break statements are never reached due to the return statement, so unnecessary
2018-03-01 08:05:15 -08:00
b713feb6f2
Add a little aside explaining that shifted keys with mod-tap doesn't work ( #2446 )
2018-03-01 07:49:50 -08:00
7f7f763598
Fixed dead links ( #2451 )
...
* Fixed typo of 'confid.h' to 'config.h'
* Fixed broken links in docs
* Fixed a lot of dead links
2018-03-01 07:45:47 -08:00
8e99fbc884
Fixed typo of 'confid.h' to 'config.h' ( #2448 )
...
* Fixed typo of 'confid.h' to 'config.h'
* Fixed broken links in docs
2018-02-28 16:43:15 -05:00
a8daf3ffba
Document bootmagic hot keys
...
- covers most of tmk_core/common/bootmagic.h
2018-02-23 13:14:53 -05:00
767f7a8cf0
Fixed formatting for Fedora example
2018-02-23 13:13:30 -05:00
d54de1c5f2
ergobox -> ergodox
2018-02-23 13:11:31 -05:00
8df2ee4ec3
Minor updates to docs ( #2406 )
...
* [docs/] Cleaning up some language to make it more clear.
* [docs/] Adding instructions for installing deps on RH / Fedora.
2018-02-19 14:09:05 -05:00
63df056013
Update feature_auto_shift.md
2018-02-12 15:45:54 -05:00
6835ae8209
Add the ability to disable Music Mode completely ( #2339 )
...
* Skip process_music in NO_MUSIC_MODE is defined
* Skip matrix_scan_music if NO_MUSIC_MODE is defined
* Skip music_all_notes_off if NO_MUSIC_MODE is defined
* Leave matrix_scan_music in, because it reduces firmware size by 150b....
* Add docs for NO_MUSIC_MODE
2018-02-08 15:16:06 -05:00
2018df1a61
Clarify the format for layout names
2018-01-19 11:58:19 -08:00
4764e77121
Clarify that we actually have max 16 total backlight levels
2018-01-12 12:52:35 -05:00
cfcf0fd36b
Remove reference to BL_x in keycodes.md, and add BL_BRTG
2018-01-12 12:52:35 -05:00
6c24e28b8d
ADD RGBLIGHT_LIMIT_VAL ( #2214 )
2018-01-02 21:54:56 -05:00
4beb5e72f8
macOS also requires avrdude
2018-01-02 14:07:10 -05:00
4931510ad3
backlight breathing overhaul ( #2187 )
...
* add breathing to bananasplit
* backlight breathing overhaul
* fix the backlight_tick thing.
* fix for vision_division backlight
* fix a few keymaps and probably break breathing for some weirdly set-up boards.
* remove BL_x keycodes because they made unreasonable assumptions
* some fixes for BL keycodes
* integer cie lightness scaling
* use cie lightness for non-breathing backlight and make breathing able to reach true max brightness
2018-01-01 17:47:51 -05:00
4f484bc1c9
Add on/off/toggle keycodes for Auto Shift
2017-12-20 14:38:56 -05:00
d8f0faabda
Fixed typo
2017-12-20 14:38:24 -05:00
eab41f7b38
Added default case to process_record_user
...
I tried using process_record_user and if I had to add the default case for it to compile.
2017-12-17 11:52:06 -05:00
8a1e656099
new planck keymap, new feature - hybrid shift/enter action key (great for small keyboards!) ( #2100 )
...
* new planck keymap, new feature - hybrid shift/enter action key (great for small keyboards!)
* corrected documentation to specify rules.mk file instead of Makefile
2017-12-14 00:20:44 -05:00
bb53635f33
Trim trailing whitespace
2017-12-09 10:46:11 -05:00
af37bb2f78
Fix some of the more obvious typos
2017-12-09 10:46:11 -05:00
4c675a83ba
Format keycode tables
2017-12-09 10:46:11 -05:00
7b0356d1d4
Convert all headings to Title Case
2017-12-09 10:46:11 -05:00
U-LANDSRAAD\drashna
Jack Humbert
Daniel Hoek
Andrew Macpherson
skullydazed
snyman
Merlin04
Jason Stillwell
fauxpark
Joe Wasson
skullY
Graham P Heath
Mitchell van Manen
Brian Choromanski
Yan-Fa Li
ferbie
Jose Pablo Mora
Ben Hilburn
Gomme_Bidule
YouCanFly
Rickard von Essen
Balz Guenat
Hugo Gayosso
kamisamamizu
Zach Richard