summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2018-04-19Correct documentation for `PREVENT_STUCK_MODIFIERS`Joe Wasson1-1/+1
2018-04-19Add Faux Clicking as subset of Audio feature (#2748)Drashna Jaelre1-0/+30
* 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-19Link to Atmel's flip is broken. (#2752)internetirl1-1/+1
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-15Fix link to command pageKevin Foley1-1/+1
2018-04-12Added support for audio using pins C4, C5, B6, B7Michael L. Walker2-2/+21
2018-04-08Remove obsolete info.json entries (#2712)skullydazed1-9/+0
2018-04-07Improve state/chord handling and clean up namespaceSeebs1-0/+24
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-01Add userspace config.h handling to build script (#2640)Drashna Jaelre1-1/+23
* 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-01Fix broken Markdown (#2652)Mike Kozlowski1-2/+2
Fix links in Keyboard Guidelines page
2018-03-28Add rgblist to docsU-LANDSRAAD\drashna1-0/+1
2018-03-26rename api docs to internalsJack Humbert8-8/+8
2018-03-26Expand Newb Guide flashing document (#2588)Drashna Jaelre1-4/+167
* Add header info * Add DFU section * Add Caterina section * Add Halfkay section * Fix Typos * More typos
2018-03-26Fixes and updates to docs (#2611)Drashna Jaelre4-15/+32
* 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-24Fix custom functions documation for layer_state_set*U-LANDSRAAD\drashna1-1/+1
2018-03-24Add HSV value specification (#2481)Daniel Hoek1-1/+1
* 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-24Fix typo in autoshift docs: statn (#2579)Andrew Macpherson1-1/+1
2018-03-22Generate API docs from source code comments (#2491)skullydazed8-0/+786
* 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-21Add macro for momentarily switching to a layer while some mods are active ↵snyman2-9/+11
(#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-20Added bootloader optionsMerlin041-1/+3
I think I got all of them, so I removed the "FIXME".
2018-03-20[Proposal?] Allow RGB Underglow to turn off when host is idle/asleep (#2104)Drashna Jaelre1-0/+2
* Add RGB Underglow Sleeping * Add RGBLIGHT_SLEEP to toggle/control RGB light behavior * Update rgb docs * Update for RGB disable command
2018-03-16Rule to enable Modifiers with Auto-Shift (#2542)Jason Stillwell1-4/+13
* Re-enable modifiers with auto-shift * Auto-shift modifiers rule * missed a line * Documentation * fixing whitespace
2018-03-16Add CMD and WIN aliases for KC_GUI, GUI(kc), GUI_T(kc), etc.fauxpark2-233/+233
2018-03-16Add keycodes for swap-hands feature.Joe Wasson2-11/+22
2018-03-16Rename ONEHAND_ENABLE to SWAP_HANDS_ENABLE for consistencyJoe Wasson1-1/+1
2018-03-09Add SS_RALT for AltGR usage in macrosDrashna Jael're1-0/+1
2018-03-08Disable the glossary linking to fix #2498 (#2499)skullydazed3-3/+3
2018-03-07Add layer_state_set_* to custom function listsU-LANDSRAAD\drashna1-1/+37
2018-03-07Examples should all use _user functions for consistencyU-LANDSRAAD\drashna1-4/+5
2018-03-07Add back docs for hand-swapping feature.Joe Wasson2-0/+32
2018-03-07Move the linux tutorials to an info box on newbs_getting_startedskullY2-5/+7
2018-03-07warn->dangerskullY1-1/+1
2018-03-07Flesh out the newbs guideskullY2-12/+50
2018-03-06Add a newbie guide for people completely new to QMK (#2480)skullydazed8-1/+292
2018-03-03Mention invalid names in the readme. (#2458)Graham P Heath1-1/+1
2018-03-02More thoroughly document Bootmagic and Command (#2455)skullydazed5-62/+165
2018-03-01Update feature_macros.md (#2387)Mitchell van Manen1-3/+3
break statements are never reached due to the return statement, so unnecessary
2018-03-01Add a little aside explaining that shifted keys with mod-tap doesn't work ↵fauxpark1-1/+7
(#2446)
2018-03-01Fixed dead links (#2451)Brian Choromanski3-5/+5
* Fixed typo of 'confid.h' to 'config.h' * Fixed broken links in docs * Fixed a lot of dead links
2018-02-28Fixed typo of 'confid.h' to 'config.h' (#2448)Brian Choromanski4-8/+10
* Fixed typo of 'confid.h' to 'config.h' * Fixed broken links in docs
2018-02-23Document bootmagic hot keysYan-Fa Li1-0/+35
- covers most of tmk_core/common/bootmagic.h
2018-02-23Fixed formatting for Fedora exampleferbie1-0/+1
2018-02-23ergobox -> ergodoxJose Pablo Mora1-1/+1
2018-02-19Minor updates to docs (#2406)Ben Hilburn3-25/+27
* [docs/] Cleaning up some language to make it more clear. * [docs/] Adding instructions for installing deps on RH / Fedora.
2018-02-12Update feature_auto_shift.mdGomme_Bidule1-1/+1
2018-02-08Add the ability to disable Music Mode completely (#2339)Drashna Jaelre1-0/+4
* 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-01-19Clarify the format for layout namesskullY1-1/+3
2018-01-12Clarify that we actually have max 16 total backlight levelsfauxpark2-2/+2
2018-01-12Remove reference to BL_x in keycodes.md, and add BL_BRTGfauxpark2-10/+10
2018-01-03ADD RGBLIGHT_LIMIT_VAL (#2214)YouCanFly1-0/+1
2018-01-02macOS also requires avrdudeRickard von Essen1-0/+1