bjacques and Drashna Jaelre
e36d6bbbe3
Update feature_tap_dance.md ( #2643 )
2018-04-21 00:43:36 -07:00
Joe Wasson and Jack Humbert
5226e4c79b
Correct documentation for PREVENT_STUCK_MODIFIERS
2018-04-19 01:52:34 -04:00
Drashna Jaelre and Jack Humbert
8b0b17a369
Add Faux Clicking as subset of Audio feature ( #2748 )
...
* Add Faux Clicky to main Audio feature
* Make clicky settings user configurable
* Add additional documentation
* Don't play when music mode is enabled (hopefully)
2018-04-19 01:47:04 -04:00
internetirl and Jack Humbert
a7fca47686
Link to Atmel's flip is broken. ( #2752 )
...
The link to Atmel's flip is broken. It re-directs to http://www.microchip.com/ . Please update!
I think this is the correct link. Please verify.
http://www.microchip.com/developmenttools/productdetails.aspx?partno=flip
2018-04-18 22:21:36 -04:00
Kevin Foley and Jack Humbert
cdb967f22b
Fix link to command page
2018-04-15 11:53:31 -04:00
Michael L. Walker and Jack Humbert
22215a0e92
Added support for audio using pins C4, C5, B6, B7
2018-04-12 13:14:48 -04:00
skullydazed and GitHub
3b525dcf9c
Remove obsolete info.json entries ( #2712 )
2018-04-07 17:37:31 -07:00
Seebs and Jack Humbert
c0baf2a964
Improve state/chord handling and clean up namespace
...
Some values that can never, ever, change were held in local
variables, rather than in PROGMEM. Fixed.
Change "pressed" to a signed int so the test for < 0 makes
sense, and to avoid possible weird failure modes in the
case where a key release comes in when pressed is already
zero. (Shouldn't happen, sure, but computers are weird.)
A lot of things in process_steno had external linkage for no
particular reason. They've been marked static. Stuff still
builds.
Distinguish between currently-held keys and keys that have
been held, and expose these values through a nicely-named API
so other code could, say, check on the current set of steno
chording in order to make displays. Also in passing fix up the
"state" value having external linkage so it could clash with
other people's variable declarations.
The API also provides hooks for key processing and steno chord
events, so you can monitor those events without having to
run in matrix_scan_user and recheck the values directly. Also
document these.
There is no path through processing a key that doesn't
end with a return false, so the nested return foo() are
gone and we just return false.
2018-04-07 17:12:44 -04:00
Drashna Jaelre and Jack Humbert
162a67cbc5
Add userspace config.h handling to build script ( #2640 )
...
* Add userspace 'config.h' file
* Add more robust docs
* Remove config.h code from drashna userspace
* Spelling error
* Include links to Config Options page
* Remove config.h documentation from userspace doc, as it's no longer needed
2018-04-01 00:02:40 -04:00
Mike Kozlowski and Drashna Jaelre
cc323df9ba
Fix broken Markdown ( #2652 )
...
Fix links in Keyboard Guidelines page
2018-03-31 20:54:01 -07:00
U-LANDSRAAD\drashna and Jack Humbert
331288233d
Add rgblist to docs
2018-03-28 16:55:58 -04:00
Jack Humbert and skullydazed
ae7284edb8
rename api docs to internals
2018-03-26 11:43:37 -07:00
Drashna Jaelre and Jack Humbert
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
Drashna Jaelre and skullydazed
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
U-LANDSRAAD\drashna and Jack Humbert
d965d72d4a
Fix custom functions documation for layer_state_set*
2018-03-24 12:49:56 -04:00
Daniel Hoek and Drashna Jaelre
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
Andrew Macpherson and Drashna Jaelre
d0054c41e2
Fix typo in autoshift docs: statn ( #2579 )
2018-03-23 16:03:19 -07:00
skullydazed and Jack Humbert
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
snyman and Jack Humbert
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
Merlin04 and Jack Humbert
6d66fe0c0c
Added bootloader options
...
I think I got all of them, so I removed the "FIXME".
2018-03-20 11:47:22 -04:00
Drashna Jaelre and Jack Humbert
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
Jason Stillwell and Jack Humbert
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
fauxpark and Jack Humbert
a2e12faa19
Add CMD and WIN aliases for KC_GUI, GUI(kc), GUI_T(kc), etc.
2018-03-16 16:37:44 -04:00
Joe Wasson and Jack Humbert
23ac2a02ef
Add keycodes for swap-hands feature.
2018-03-16 16:33:43 -04:00
Joe Wasson and Jack Humbert
7230923b05
Rename ONEHAND_ENABLE to SWAP_HANDS_ENABLE for consistency
2018-03-16 16:33:43 -04:00
Drashna Jael're and Jack Humbert
3f1d147529
Add SS_RALT for AltGR usage in macros
2018-03-09 13:15:10 -05:00
skullydazed and GitHub
566399794a
Disable the glossary linking to fix #2498 ( #2499 )
2018-03-08 10:31:08 -08:00
U-LANDSRAAD\drashna and Jack Humbert
42e85d2b92
Add layer_state_set_* to custom function lists
2018-03-07 17:05:38 -05:00
U-LANDSRAAD\drashna and Jack Humbert
d27d854913
Examples should all use _user functions for consistency
2018-03-07 17:05:38 -05:00
Joe Wasson and Jack Humbert
7b80aea8b2
Add back docs for hand-swapping feature.
2018-03-07 16:56:57 -05:00
skullY
48e11240a6
Move the linux tutorials to an info box on newbs_getting_started
2018-03-06 20:51:26 -08:00
skullY
75354f12d7
warn->danger
2018-03-06 15:39:46 -08:00
skullY
6a4e08938e
Flesh out the newbs guide
2018-03-06 15:22:47 -08:00
skullydazed and GitHub
08e48eb6f5
Add a newbie guide for people completely new to QMK ( #2480 )
2018-03-06 14:37:48 -08:00
Graham P Heath and skullydazed
b36b4382d0
Mention invalid names in the readme. ( #2458 )
2018-03-03 09:52:09 -08:00
skullydazed and GitHub
e87c39d302
More thoroughly document Bootmagic and Command ( #2455 )
2018-03-02 09:21:03 -08:00
Mitchell van Manen and skullydazed
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
fauxpark and skullydazed
b713feb6f2
Add a little aside explaining that shifted keys with mod-tap doesn't work ( #2446 )
2018-03-01 07:49:50 -08:00
Brian Choromanski and skullydazed
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
Brian Choromanski and Jack Humbert
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
Yan-Fa Li and Jack Humbert
a8daf3ffba
Document bootmagic hot keys
...
- covers most of tmk_core/common/bootmagic.h
2018-02-23 13:14:53 -05:00
ferbie and Jack Humbert
767f7a8cf0
Fixed formatting for Fedora example
2018-02-23 13:13:30 -05:00
Jose Pablo Mora and Jack Humbert
d54de1c5f2
ergobox -> ergodox
2018-02-23 13:11:31 -05:00
Ben Hilburn and Jack Humbert
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
Gomme_Bidule and Jack Humbert
63df056013
Update feature_auto_shift.md
2018-02-12 15:45:54 -05:00
Drashna Jaelre and Jack Humbert
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
skullY
2018df1a61
Clarify the format for layout names
2018-01-19 11:58:19 -08:00
fauxpark and Jack Humbert
4764e77121
Clarify that we actually have max 16 total backlight levels
2018-01-12 12:52:35 -05:00
fauxpark and Jack Humbert
cfcf0fd36b
Remove reference to BL_x in keycodes.md, and add BL_BRTG
2018-01-12 12:52:35 -05:00
YouCanFly and Jack Humbert
6c24e28b8d
ADD RGBLIGHT_LIMIT_VAL ( #2214 )
2018-01-02 21:54:56 -05:00