Commit Graph

755 Commits (9dc5432a3e16ca4ee42d84cacbcfa7aeee97d2f9)

Author SHA1 Message Date
Evan Travers 3d7bfae232 Add Userspace mention
@drashna mentioned it'd be good to have a mention of the userspace in
the QMK structure section. Rather than rewrite the docs on userspace, I
chose to link to the existing documentation.
7 years ago
Evan Travers b666921e25 Reword the `config.h` section
This section didn't include the possibility of a user `config.h`, and it
wasn't clear exactly how the settings override works.
7 years ago
Evan Travers b4f4576631 Update docs: `Makefile` -> `rules.mk`
I think this was a typo, or perhaps an older way to handle it.
7 years ago
KeLorean c7b8e45ba1 Docs: add resources for git (#3390)
* add resources for git

* add more resources
7 years ago
Fred Silberberg 48913153c3 Replace gitter links with Discord. (#3368) 7 years ago
Evan Travers 0d5a8b048a Instruct macos users to use avr-gcc@7 (#3337)
If you run `brew install avr-gcc`, you get a version that has
compatibility issues with LUFA. I updated the getting started guide for
osx, the qmk_install setup script, and added a section to the FAQ for
folks like me who accidentally updated avr-gcc past 7.
7 years ago
Nicolas Schodet 7fef5ca240 Add documentation for TAPPING_FORCE_HOLD (#2957) (#3320)
Also improve documentation for related settings.
7 years ago
yiancar a7df902734 Addition of hard brigtness limit for RGB_Matrix (#3299)
* Addition of hard brigtness limit for RGB_Matrix

- Added a define "RGB_MATRIX_MAXIMUM_BRIGHTNESS" to enable hard limiting the maximum brightness for rgb_matrix
- Used the above define to limit the maximum brigthness of HS60 for better stability

* Added docs for new rgb_matrix define

* Addition of check for maximum brightness
7 years ago
fauxpark 6590f3c811 Clean up SEND_STRING keycodes and add media keys (#3214)
* Clean up SEND_STRING keycodes and add media keys

* Remove stray define

* Add missing SEND_STRING keycodes for completeness

Also, add KC_EJCT to the keycode references
7 years ago
Takeshi ISHII 5229734647 Add rgblight mode 35 (R,G,B test mode) (#3114)
* add rgblight mode 35 (RGB cyclic mode) into quantum/rgblight.c

* Update docs, add rgblight mode 35(RGB cyclic)

* rename RGBCYCLIC to RGBTEST
7 years ago
Drashna Jaelre cb91320d6d Add Suspend functions (#3112)
* Add suspend functions

* Disable RGB code if it's disabled

* Add suspend code to ChibiOS for future compatibility

* Add keyboard_init functions

* Change where references so it will compile

* Wrong command chained in wake up kb function

* Fix non-feature file changes

* Add documentation

* Re-add matrix init docs

* add rgblight code to example

* Remove keyboard init stuff for separate PR
7 years ago
Dan Hertz 9fb1e5d171 Remove bootloader key as it is no longer used (#3093) 7 years ago
Drashna Jaelre 751719e6cb Add and fix _noeeprom functions to many of the RGB Underglow functions (#3070)
* And and fix _noeeprom functions to many of the RGB Underglow functions

* Many functions are unnecessarily calling the eeprom write code. The toggle/enable is command is especially guilty of this, as it writes to EEPROM 3 times.  But rgb mode writes twice, every time it's called. And init resets the rgb eeprom range and then writes back to it twice!
* Fixed the rgblight_sethsv_noeeprom to work as expected, by moving a lot of the code to a helper function.
* Added a noeeprom function for mode, enable, disable, and toggle functions. (didn't bother for increase/decrease stuff, and didn't add new keycodes)
* Add to predefined colors list
* Add new functions to manual/docs

* Update RGB Sleep feature to use _noeeprom

Because that's exactly what it should be doing, actually!
7 years ago
arlenk a87b36d791 fix a few simple typos (#3068)
* Update feature_tap_dance.md

* minor typos
7 years ago
Leo Wzukw 3b1ddd12a5 Refresh & improve leader documentation page (#2990)
* Refresh & improve leader documentation page

- register_code/unregister_code are not the recommanded way to do macro.
- Provide some details I wish I had found when first used the leader
  functionality.

* Add old way to use macro.
7 years ago
Alexander Dang-Tran 73ddb764cc Fix readme and contributing hyperlinks 7 years ago
yiancar 470c50ddb6 Update documentation for rgb matrix (#3023)
* Update documentation for rgb matrix

- Updated keycodes.md to include RGB matrix keycodes + necessary link
7 years ago
GreenShadowMaker 06b3637266 added some helpful notes to the documentation (#2981) 7 years ago
Jack Humbert 4d26137e2a Create CNAME 7 years ago
Drashna Jaelre 9f2bb11412 Make sure new features (RGB Matrix) are actually listed 7 years ago
Chris Fung 7d49a17781 override hamburger placement 7 years ago
Drashna Jaelre bfb5922f87 List all Tap Dancing functions (#2945)
* List all Tap Dancing functions

* Spelling, which drashna can't do apparently
7 years ago
yiancar c89565cc3d General RGB matrix fixes (#2931)
* Added Modular keyboards L,R and NUM

Created code modules for the 3 modules of the modular keyboard.
Original idea by MechboardsUK. Uses i2c implementation similar to lets
split

* Remove modular from master

This is to fix incorrect branching

* General fixes for RGB_matrix

- Complited speed support for all effects
- Fixed raindrop effects to initialized after toggle
- Fixed raindrop effects to use all available LEDs
- Fixed effect step reverse function
- Moved RGB_MATRIX_SOLID_REACTIVE under correct flag

* Documentation update for RGBmatrix

* More doc updates
7 years ago
Mikkel Jeppesen 00596d55e3 Added propper support for Lets split vitamins (#2559)
* Added support for the upcomming Lets_split vitamins included

* Updated readme

* Corrected header of readme

* Enabled RGB

* Broke everything

* broke some more shit

* Revert "broke some more shit"

This reverts commit 6ad68e6269cc0d04c16564ce9598dfd3db1e23c1.

* Revert "Broke everything"

This reverts commit feeee4e40db15a726f2292b6a9406ef45c1e54a7.

* Fixed USB detection, and RGB on slave

* started modifying readme, to use msys2

* Added support for the upcomming Lets_split vitamins included

* Updated readme

* Corrected header of readme

* Enabled RGB

* Broke everything

* broke some more shit

* Revert "broke some more shit"

This reverts commit 6ad68e6269cc0d04c16564ce9598dfd3db1e23c1.

* Revert "Broke everything"

This reverts commit feeee4e40db15a726f2292b6a9406ef45c1e54a7.

* Fixed USB detection, and RGB on slave

* started modifying readme, to use msys2

* Updated readme to reflect use of msys2 Added avrdude to msys path

* added avrdude option to msys installer

* Removed extra installation of avrdude

* Renamed to vitamins_included and implemented drashnas changes

* Fixed include guard

* Fixed some includes, and added avrdude target to docs.

* Fixed default keyboard
7 years ago
Jack Humbert 6ba73e0e04 update doc options 7 years ago
yiancar afacd42368 Add effect speed support for RGB Matrix *No EEPROM yet* (#2922)
* Added Modular keyboards L,R and NUM

Created code modules for the 3 modules of the modular keyboard.
Original idea by MechboardsUK. Uses i2c implementation similar to lets
split

* Remove modular from master

This is to fix incorrect branching

* Add effect speed support for RGB Matrix *No eeprom yet*

Keycodes RGB_SPI and RGB_SPD have been added to increase and decrease effect speed.

Speed is not saved in EEPROM yet as per Jack's request.

* Update rgb_matrix.c

* RGB Matrix speed fix rgblight.h

* More fixes for rgb speed. Speed functions declared but not used in rgblight

* More travis fixes..

* Another one for travis..
7 years ago
Jack Humbert c6ea96ab43 Merge branch 'master' of github.com:qmk/qmk_firmware 7 years ago
Jack Humbert 63d5c947d3 updated music mask 7 years ago
skullY 466ee76423 switch to the vue theme and add search 7 years ago
Jack Humbert 14b7602a65
Adds IS31FL3731 RGB Matrix Implementation (#2910)
* adds is31fl3731 rgb matrix implementation

* fix build script for force pushes

* allow bootloader size to be overwritten

* adds planck light implementation

* split led config into 2 arrays

* idk

* betterize register handling

* update planck implementation

* update planck

* refine rgb interface

* cleanup names, rgb matrix

* start documentation

* finish up docs

* add effects list

* clean-up merge

* add RGB_MATRIX_SKIP_FRAMES

* add support for at90usb1286 to bootloader options
7 years ago
skullY ccc87421e7 Some more tweaks to make everything look nice 7 years ago
skullY 303f425c6b Fix up info boxes. 7 years ago
skullY 9e5676650e Use docsfy to replace gitbook 7 years ago
Daniel Gordon e6be4484e9 Update to tap dance docs (#2895)
* Added more comments
    * Documentation for 'quad function' tap dance now suggests to use the
      user's directory, and explains how to do so.
7 years ago
Charles Pletcher 9b91789193 Add dilly/pletcher layout (#2880)
* Add pletcher keymap to dilly/keymaps

For the moment, this keymap just removes unneeded RGB keycodes, since
an iPad will cut the keyboard off if LEDs are turned on.

* Drop support for A_RSFT, add media and autoshift

* Lower USB_MAX_POWER_CONSUMPTION for dilly on iPad

* Document USB_MAX_POWER_CONSUMPTION

This config option is useful for limiting the requested power by, e.g.,
an iOS device. While the default value is 500, a much lower value--say,
50--can sufficiently power a small keyboard without LEDs.
7 years ago
M1K 5112af887a Added command history to terminal with other bug fixes, added new song to song_list.h (#2855)
* Implemented Terminal + added song to song_list.h

* Added wait() in order to prevent misbehaviour of 'command not found'
7 years ago
Joe Wasson 5ca9aecfb4 Talljoe's layout with common keymap. (#2764)
* Add userspace to talljoe layout.

* Move more authority to userspace and create Bananasplit layout.

* Move more things into userspace.

* Common Core example

* More work on common layout.

* Num layer.

* talljoe-ansi layout

* Updates for Zeal60

* Add Zeal60 to 60_ansi_split_bs_rshift

* Swap Escape and Grave

* Num-layer tweaks

* More tweaks.

* Add 1up60rgb to world of layouts.

* Rename ansi_split_bs_rshift layout to hhkb.

* Control RGB Backlight.

* change capslock led

* Remove obsolete line from rules.mk.

* Add user-friendly userspace override.

* Fix enter for 1uprgb60

* Revert "Rename ansi_split_bs_rshift layout to hhkb."

This reverts commit 53133719db25c7cb6a199108bbf5d980481a45f4.
7 years ago
Mike Kozlowski d1c3419d2a Rework layer function docs (#2656)
* Rework layer function docs

* Update per PR feedback
7 years ago
bjacques e36d6bbbe3 Update feature_tap_dance.md (#2643) 7 years ago
Joe Wasson 5226e4c79b Correct documentation for `PREVENT_STUCK_MODIFIERS` 7 years ago
Drashna Jaelre 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)
7 years ago
internetirl 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
7 years ago
Kevin Foley cdb967f22b Fix link to command page 7 years ago
Michael L. Walker 22215a0e92 Added support for audio using pins C4, C5, B6, B7 7 years ago
skullydazed 3b525dcf9c
Remove obsolete info.json entries (#2712) 7 years ago
Seebs 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.
7 years ago
Drashna Jaelre 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
7 years ago
Mike Kozlowski cc323df9ba Fix broken Markdown (#2652)
Fix links in Keyboard Guidelines page
7 years ago
U-LANDSRAAD\drashna 331288233d Add rgblist to docs 7 years ago
Jack Humbert ae7284edb8 rename api docs to internals 7 years ago
Drashna Jaelre ee1bb85542 Expand Newb Guide flashing document (#2588)
* Add header info

* Add DFU section

* Add Caterina section

* Add Halfkay section

* Fix Typos

* More typos
7 years ago
Drashna Jaelre 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
7 years ago
U-LANDSRAAD\drashna d965d72d4a Fix custom functions documation for layer_state_set* 7 years ago
Daniel Hoek 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.
7 years ago
Andrew Macpherson d0054c41e2 Fix typo in autoshift docs: statn (#2579) 7 years ago
skullydazed 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
7 years ago
snyman 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
7 years ago
Merlin04 6d66fe0c0c Added bootloader options
I think I got all of them, so I removed the "FIXME".
7 years ago
Drashna Jaelre 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
7 years ago
Jason Stillwell 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
7 years ago
fauxpark a2e12faa19 Add CMD and WIN aliases for KC_GUI, GUI(kc), GUI_T(kc), etc. 7 years ago
Joe Wasson 23ac2a02ef Add keycodes for swap-hands feature. 7 years ago
Joe Wasson 7230923b05 Rename ONEHAND_ENABLE to SWAP_HANDS_ENABLE for consistency 7 years ago
Drashna Jael're 3f1d147529 Add SS_RALT for AltGR usage in macros 7 years ago
skullydazed 566399794a
Disable the glossary linking to fix #2498 (#2499) 7 years ago
U-LANDSRAAD\drashna 42e85d2b92 Add layer_state_set_* to custom function lists 7 years ago
U-LANDSRAAD\drashna d27d854913 Examples should all use _user functions for consistency 7 years ago
Joe Wasson 7b80aea8b2 Add back docs for hand-swapping feature. 7 years ago
skullY 48e11240a6 Move the linux tutorials to an info box on newbs_getting_started 7 years ago
skullY 75354f12d7 warn->danger 7 years ago
skullY 6a4e08938e Flesh out the newbs guide 7 years ago
skullydazed 08e48eb6f5
Add a newbie guide for people completely new to QMK (#2480) 7 years ago
Graham P Heath b36b4382d0 Mention invalid names in the readme. (#2458) 7 years ago
skullydazed e87c39d302
More thoroughly document Bootmagic and Command (#2455) 7 years ago
Mitchell van Manen 31cae1f1bd Update feature_macros.md (#2387)
break statements are never reached due to the return statement, so unnecessary
7 years ago
fauxpark b713feb6f2 Add a little aside explaining that shifted keys with mod-tap doesn't work (#2446) 7 years ago
Brian Choromanski 7f7f763598 Fixed dead links (#2451)
* Fixed typo of 'confid.h' to 'config.h'

* Fixed broken links in docs

* Fixed a lot of dead links
7 years ago
Brian Choromanski 8e99fbc884 Fixed typo of 'confid.h' to 'config.h' (#2448)
* Fixed typo of 'confid.h' to 'config.h'

* Fixed broken links in docs
7 years ago
Yan-Fa Li a8daf3ffba Document bootmagic hot keys
- covers most of tmk_core/common/bootmagic.h
7 years ago
ferbie 767f7a8cf0 Fixed formatting for Fedora example 7 years ago
Jose Pablo Mora d54de1c5f2 ergobox -> ergodox 7 years ago
Ben Hilburn 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.
7 years ago
Gomme_Bidule 63df056013 Update feature_auto_shift.md 7 years ago
Drashna Jaelre 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
7 years ago
skullY 2018df1a61 Clarify the format for layout names 8 years ago
fauxpark 4764e77121 Clarify that we actually have max 16 total backlight levels 8 years ago
fauxpark cfcf0fd36b Remove reference to BL_x in keycodes.md, and add BL_BRTG 8 years ago
YouCanFly 6c24e28b8d ADD RGBLIGHT_LIMIT_VAL (#2214) 8 years ago
Rickard von Essen 4beb5e72f8 macOS also requires avrdude 8 years ago
Balz Guenat 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
8 years ago
Drashna Jael're 4f484bc1c9 Add on/off/toggle keycodes for Auto Shift 8 years ago
Hugo Gayosso d8f0faabda Fixed typo 8 years ago
kamisamamizu 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.
8 years ago
Zach Richard 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
8 years ago
fauxpark bb53635f33 Trim trailing whitespace 8 years ago
fauxpark af37bb2f78 Fix some of the more obvious typos 8 years ago
fauxpark 4c675a83ba Format keycode tables 8 years ago
fauxpark 7b0356d1d4 Convert all headings to Title Case 8 years ago
Balz Guenat 8b1862330a fix link for grave escape in docs 8 years ago
Colin T.A. Gray 16546ee06f Add 'rgblight_disable' and 'rgblight_setrgb_at/rgblight_sethsv_at'
Refactors rgblight_toggle to use rgblight_enable or rgblight_disable
Use 'rgblight_setrgb_at/rgblight_sethsv_at' to control an individual LED
8 years ago
Colin T.A. Gray 53b043d4ef adds 'RGB_RMOD' to go through RGB modes in reverse 8 years ago
Drashna Jaelre 7b51f050d7 Fix typo in make example
It has `:all" when it clearly is referencing the command without `:all`.
8 years ago
mmikeww 0740e84d63 update advanced_keycodes; oneshot = sticky/dead keys 8 years ago
mmikeww c917888262 update glossary; oneshot key = sticky/dead key 8 years ago
skullY 0b54e7f5ae Flesh out the grave escape overrides 8 years ago
mmikeww b9f426ae1e Fix broken link in docs
This link was broken. And the latest, live version of that keymap link doesn't line up with the docs below, so the link will now point to the older version of the file in the git history
8 years ago
Devin J. Pohly 7aaef16266 Fix internal links in docs/ (#2080)
One link in the summary (Modding your keyboard) referred to a page that
was deleted; the rest have been updated to point to the new names.
8 years ago
Drashna Jael're 28874a9f33 Fixed minor typo in bootloader code 8 years ago
Drashna Jael're 319ff649ab 16 byte optimization of macro ;) 8 years ago
Drashna Jael're 92f6d6ec02 Update Userspace info to include Bootloader detection 8 years ago
Jack Humbert 9fdc276260
Updates bootloader settings, adds file size check (#2029)
* pull fuse settings for bootloader jump

* fix 32a chips

* make automatic bootloader selection optional

* quantify bootloaders

* fixs #164, speeds up dfu reset

* fix for chips w/o usb

* missing an n

* fix bootloader sizes, use words for addresses

* fix bmini, pearl, and [[ issue, make things quiet

* ignore avr errors on arm for now

* update settings for the light

* document bootloader stuff

* add bootloader title
8 years ago
Jack Humbert 62eed0e4a3
Update config_options.md 8 years ago
Jack Humbert c8bdc75e1d
Update feature_layouts.md 8 years ago
Seebs 39d3d92364 Allow multiple process_record() calls per scan
This is particularly relevant for, e.g., the ergodox EZ and
other keyboards with slow scan rates. Without changing the API or
behavior of individual process_record() calls, we allow a
configuration flag to make multiple calls in a single scan.

This will probably have miniscule effects on non-steno users,
and it's not enabled by default for any keyboards. Added note
about it to ergodox README.

Signed-off-by: seebs <seebs@seebs.net>
8 years ago
Gilbert Consellado 7ff96877d2 added SS_LSFT to featured macros 8 years ago
Balz Guenat 858c09f370 add example keymap 8 years ago
Balz Guenat 179d64d33c extend macro docs a bit 8 years ago
drashna 3c15c48e6a Add "KC_MAKE" to userspace example 8 years ago
James 309a400b3e Update hand_wire.md
Change "Resin" to "Rosin"
8 years ago
Erin Call 392121b10e Document the Teensy hardware reset problem 8 years ago
skullY 4df4fa7c26 Clarify `KC_PWR` vs `KC_POWER`. Fixes #1994. 8 years ago
skullY 66f13e4972 Move keycodes to their own section 8 years ago
Jack Humbert bb11df6b7a update some docs 8 years ago
Zach Burchill e236f1eba1 Fixed some grammar and typos on the docs (#1989)
* fixed grammar and references

* fixed typo
8 years ago
Fred Silberberg 89357b96d4 333fred layout update (#1971)
* Set up tap dance for layers on the lower button.

* Refactored code to share in the users directory between my two keyboard layouts.

* Small keyboard layout change.

* Updated documentation on oneshot usage in macros/tap dance.
8 years ago
Jeremy Cowgar 245b3376d6 Correct the rules.mk documentation for auto shift.
fixes #1965
8 years ago
skullY 535c2f60a9 use real greater than and less than chars 8 years ago
skullY 432674781a Document info.json files 8 years ago
skullY 4e41beeaa6 Fix a typo 8 years ago
Jack Humbert 00733f4b87 update contributing guidelines 8 years ago
Jack Humbert d069a42c07
Update getting_started_github.md 8 years ago
Arialdo Martini 32bb8f6b8a Improvements to documentation (#1919)
* Typo: Github => GitHub

* Typo: windows => Windows, docker => Docker, and some punctuations

* "QMK Introduction" links to the right file

* "Unix" rather than "UNIX", which is a trademark

* Directory name is "keyboards", not "keyboard"

* "handwired" is a subdirectory of "keyboards"

* Punctuation and minor fixes

* macOS rather than Mac

* Punctuation and other minor fixes

* Vagrant Guide links to an existing file

* Jun Wako referenced with his name rather than his nickname

* Saxon genitive 's outside the link
8 years ago
Jack Humbert 38261920a9
update hand wiring link 8 years ago
tsankuanglee 04b9b62bdc RETRO_TAPPING (#1922)
* add RETRO_TAP: tap anyway, even after TAP_TERM, if no interruption

* consistent variable name

* add option doc

* change name for consistency

* make RETRO_TAPPING default to off
8 years ago
Zach Burchill 4c1164c469 fixed two typos
I'm almost 100% sure "else if (state->count = 2) {" was a typo (it should have two ='s for a logical operator), and I'm *pretty* sure "if (state->interrupted || state->!pressed) return SINGLE_TAP;" has a typo. At least, it returns an error on my machine saying something about an unexpected '!'.  
I changed it to a slightly longer form (i.e., "state->pressed==0"), and that worked fine.
8 years ago
Jeremy Cowgar 49c32021db Added missing RGB and Auto Shift in main feature list. Also standardized on period at the end of each feature list item. 8 years ago
Jeremy Cowgar 76d807fe7d Fix code example in auto shift docs 8 years ago
Jeremy Cowgar bf1fedc05e Fixed various feature links 8 years ago
Jack Humbert 4d421ee31c adds flashing docs 8 years ago
skullydazed 67cc5cebc0 Restructure the hardware and feature docs to make things easier to find (#1888)
* fix #1313 by documenting more config.h options

* Clean up and organize documentation
8 years ago
Sebastian Kaim 1f43495922 Added a new keycode for cycling through RBG modes which reverses directions when shift is hold.
This commit adds a new keycode `RGB_SMOD` which is the same as `RGB_MOD` (cycle through all modes),
but when it is used in combination with shift it will reverse the direction.
8 years ago
Daniel Gordon 725aa5b820 Update to Tap-Dance Docs for Fast Typists
* Quad function tap dance works as intended when typing fast
    * Example 4 in doc has been updated

Change-Id: If33406299e2eed49152c495da92f4977dfdc1e2f
8 years ago
Jack Humbert 06f196c589 Creates a userspace for keymaps (#1559)
* create a user space

* adds example

* document, add readme.md

* jackhumbert userspace, ergodox keymap
8 years ago
skullY 9bb259b660 Fix the naming for clueboard files 8 years ago
James 3276c4c56a Minor punctuation and grammar edits. 8 years ago
Jason Milkins 78923cb884 Fix code backticks on Frequently Asked Build Questions docs 8 years ago
Jason Milkins a860d9d628 Fix missing code backticks 8 years ago
Daniel Gordon 383e508bc5 Quad Function Tap Dance added to TD Doc
* Added section to example, detailing how to accomplish the
        'quad-function' tap dance.
    * Refactored TD documentation to clearly separate different complex
        examples

Change-Id: Ifc1495d1142849c771418fdabc458c04c48311e6
8 years ago
skullydazed ad49db8cd2 Address #1689 by using a formula to define the breathing curve (#1692)
* Address #1689 by using a formula to define the breathing curve and exposing defines to control the shape of the curve.

* Tweak the behavior of breathing for clueboard
8 years ago
Dylan Khor aa660c1eb7 Broken link found in issue #1845 8 years ago
Jack Humbert 800ec55dfc Make arguments redo, subproject elimination (#1784)
* redo make args to use colons, better folder structuring system [skip ci]

* don't put spaces after statements - hard lessons in makefile development

* fix-up some other rules.mk

* give travis a chance

* reset KEYMAPS variable

* start converting keyboards to new system

* try making all with travis

* redo make args to use colons, better folder structuring system [skip ci]

* don't put spaces after statements - hard lessons in makefile development

* fix-up some other rules.mk

* give travis a chance

* reset KEYMAPS variable

* start converting keyboards to new system

* try making all with travis

* start to update readmes and keyboards

* look in keyboard directories for board.mk

* update visualizer rules

* fix up some other keyboards/keymaps

* fix arm board ld includes

* fix board rules

* fix up remaining keyboards

* reset layout variable

* reset keyboard_layouts

* fix remainging keymaps/boards

* update readmes, docs

* add note to makefile error

* update readmes

* remove planck keymap warnings

* update references and docs

* test out tarvis build stages

* don't use stages for now

* don't use stages for now
8 years ago
Jonathan Arnett 4c0ff7b7ea Remove reference to Ergodox subprojects from docs
At one time, "ez" and "infinity" may have been subprojects of a
unified "ergodox" project, but this is not currently the case. Running
`make ergodox-ez-default-teensy` (or similar), as the documentation
currently implies, does not work.
8 years ago
skullY db5afb05cf Fix the presentation of the contribution guide 8 years ago
skullydazed 2db4ad2133 Write a contributing guide. (#1827) 8 years ago
Jesper Brix Rosenkilde 966e2660cf Add option to reverse PS2 mouse axes and scrolling 8 years ago
Snipeye cfd118d158 Added Dichotemy Keyboard, updated docs for Pointing Device (#1817)
* Added Dichotemy Keyboard, updated docs for Pointing Device

* Updated readme

* Updated mouse report pointer in pointing_device.c
8 years ago
lyuts d8c62e4238 Fixed typo in docs. (#1818) 8 years ago
Snipeye ee13228486 Generic Pointing Device (#1767) 8 years ago
Dylan Khor 0cc62459a7 Minor typo 8 years ago
Sebastian Kaim 29bcffb3f3 Edited a minor typo in feature_bootmagic.md. 8 years ago
Daniel Gordon 03de0c8575 Reference to rules.mk in tap dance docs added
Change-Id: I64aa6f95a30ab05f0ed3f499e54b9e125d379fad
8 years ago
Max Riveiro f1451b4b04 Fix HSV Color Wheel image on RGB Light page (#1773)
Signed-off-by: Max Riveiro <kavu13@gmail.com>
8 years ago
Lukas Werling 1ad941e984 Add shell.nix for NixOS users 8 years ago
Zach Burchill 809c9258c1 Fixed typo of "multually" to "mutually" 8 years ago
surlyjake c8d365f5da platform descriptions to match master keycodes.md documentation 8 years ago
surlyjake 957e44231a updated keycodes media descriptions
Platform compatibility descriptions added for mute, volume up/down
8 years ago
Jeremy Cowgar a89183591c Fixed a few typos and spelling errors in auto shift feature document 8 years ago
Jeremy Cowgar abba393f57 Added Auto Shift, tap key = normal, hold key = shifted state. 8 years ago
Jack Humbert 7ad924bae5 Updates send_string functionality, adds terminal feature (#1657)
* implement basic terminal stuff

* modify send_string to read normal strings too

* add files bc yeah. working pgm detected

* pgm detection apparently not working

* adds send string keycodes, additional keycode support in send string

* implement arguments

* [terminal] add help command

* [terminal] adds keycode and keymap functions

* [terminal] adds nop.h, documentation

* update macro docs
8 years ago
skullydazed 4cdcbdb861 Remove all Makefiles from the keyboards directory. (#1660)
* Remove all Makefiles from the keyboards directory.

* update keymaps added in the last 8 days

* Ignore keyboard/keymap makefiles

* update hand_wire to reflect our new Makefile-less reality

* Update the make guide to reflect the new reality

* move planck keymap options to rules.mk

* update planck keymaps 4real

* trigger travis

* add back build_keyboard.mk

* restore changes to build_keyboard
8 years ago
skullydazed 4580d3a730 RGB improvements (#1684)
* Allow the knight animation to be restricted to a portion of the LED strip

* Add keys for jumping directly to particular animation modes

* Remove orphaned break statements

* Tweak the `RGB_MODE` buttons so they cycle through the same mode.

* small indentation fix
8 years ago
Will Jiang 0ce45eb0b7 Update mac guide (#1665)
`avr-libc` is no longer, and it's called `avr-gcc` now. https://github.com/osx-cross/homebrew-avr

Also you need `gcc-arc-none-eabi` to be able to compile in my experience.
8 years ago
Jack Humbert 5f154f0a00 Update feature_common_shortcuts.md 8 years ago
Marco Fontani da83f04a30 add UC_OSX_RALT to make unicode use the Right Alt key on OSX 8 years ago
Jack Humbert d2ff66a985 Creates a layouts/ folder for keymaps shared between keyboards (#1609)
* include variables and .h files as pp directives

* start layout compilation

* split ergodoxes up

* don't compile all layouts for everything

* might seg fault

* reset layouts variable

* actually reset layouts

* include rules.mk instead

* remove includes from rules.mk

* update variable setting

* load visualizer from path

* adds some more examples

* adds more layouts

* more boards added

* more boards added

* adds documentation for layouts

* use lowercase names for LAYOUT_

* add layout.json files for each layout

* add community folder, default keymaps for layouts

* touch-up default layouts

* touch-up layouts, some keyboard rules.mk

* update documentation for layouts

* fix up serial/i2c switches
8 years ago
Joe Wasson bdc0880ca5 Add compile error if too many endpoints are defined for the ATmega32U4. 8 years ago
Jack Humbert 5cab5e4a4e validates json 8 years ago
Jack Humbert d8145c8464 adds redirects for docs 8 years ago
Joe Wasson 94ca84d271 Fix incorrect name for GeminiPR in docs. 8 years ago
Jack Humbert 52f2f6d8ea adds audio docs to summary 8 years ago
Benny Powers 9fed4f7948 Add link to keycodes doc in how_keyboards_work 8 years ago
Roy Wellington Ⅳ c0a6935fb3 Fix these links, as they appear to be broken (#1595)
It looks like build_environment_setup.md got renamed to
getting_started_build_tools.md in this commit:

	commit e6c638bed1
	Author: skullY <skullydazed@gmail.com>
	Date:   Sat Aug 5 20:54:34 2017 -0700

		Overhaul the Getting Started section and add a FAQ section

	 docs/{build_environment_setup.md => getting_started_build_tools.md} | 132 ++++++++++++++++++++++++++++++++++++-------------------------------------

This commit adjusts the links to match the new name.
8 years ago
Jack Humbert b483a90a90 update favicons 8 years ago
skullY f02430b131 Update links in the glossary 8 years ago
skullY 9d1a08e38a Doc updates from going through every file 8 years ago
skullY 9b879b1267 break up keymaps and quantum keycodes into files by feature 8 years ago
skullY 2709744cdd take a stab at documenting layers 8 years ago
skullY 207bcd788a rework key_functions into feature_common_shortcuts 8 years ago
skullY e6c638bed1 Overhaul the Getting Started section and add a FAQ section 8 years ago
discursivemoth b7d43ee253 correct tilde to grave 8 years ago
Balz Guenat 430151dd51 Merge remote-tracking branch 'upstream/master'
# Conflicts:
#	docs/faq_keymap.md
8 years ago
Balz Guenat 175db1a549 fix code block formatting 8 years ago
Balz Guenat 5ad103fa51 add description of new option to docs and add option (commented out) into template. 8 years ago
Balz Guenat 3e67cc9c80 add description of new option to docs and add option (commented out) into template. 8 years ago
Danny Nguyen f1536a3f54 Change installation of avr-libc to avr-gcc, now that avr-libc is integrated into the avr-gcc build 8 years ago
Fredric Silberberg a3e1d9a8cc Added support for locking One Shot modifiers. 8 years ago
Fredric Silberberg 5fc4a664dc Added initial key lock documentation. 8 years ago
Jack Humbert 9e79bb1491 Merge pull request #1554 from qmk/docs
Updates some remaining doc stuff
8 years ago
Balz Guenat 525b3deadf add short name for locking mods to docs. 8 years ago
Balz Guenat 07ba06d0b6 fix section in porting guide that refered to Makefile instead of rules.mk 8 years ago
Joe Wasson c5780647d8 Fix typo in docs. 8 years ago
Joe Wasson 26fb063be3 Link to steno docs from summary page. 8 years ago
Joe Wasson c0f63ca9dc Add documentation for Steno. 8 years ago
Jack Humbert cefc09ae7d adds option for alt pitch standards 8 years ago
Joe Wasson a543ad4c1d Fix minor formatting issue. 8 years ago
Jack Humbert 6bdf7482b1 update audio/music documentation 8 years ago
Jack Humbert 9abbbe7089 update audio documentation 8 years ago
Jack Humbert f407f3e8de remove unneccesary headers 8 years ago
Jack Humbert fe113ebad5 start updating audio docs 8 years ago
Jack Humbert 14c5160b1a Update _summary.md 8 years ago
Jack Humbert 000e749853 Rename docs/features/README.md to docs/features.md 8 years ago
Erez Zukerman 585f140052 Invites contributions 8 years ago
skullY 4c7c7747a3 Add terminal examples to doc best practices 8 years ago
skullY 5810bb67e4 Rearrange the faq a bit 8 years ago
skullY cb9e59152e Flesh out the glossary 8 years ago
skullY 03eb6a3e86 comment out unformatted audio/midi sections 8 years ago
skullydazed ecd3dbf085 Merge branch 'master' into docs 8 years ago
cato976 1896c76a29 Update mouse_keys.md
fix typo
8 years ago
Shayne Holmes 48ff93582b Pull out sendstring variations to their own files.
Instead of having all sendstring keycode mappings in the main quantum.c
file, give each one its own file in keymap_extras that can be #included
in a user's keymap. If one is included, it will define the appropriate
lookup tables and overwrite the weak definitions in quantum.c.
(Including more than one sendstring definition will fail at compile
time.)

Update @rai-suta's test keymap to match, as well as the documentation.
8 years ago
skullY 9cadba7b89 Add missing files to _summary.md 8 years ago
skullY f1c581fdd4 Remove obsolete documentation 8 years ago
skullY c12f19107f update the summary 8 years ago
skullY 2abff258b1 Adjust headings on unicode 8 years ago
skullY 0ded95b888 Update the vagrant guide 8 years ago
skullY ff47ca7a46 update hand_wire 8 years ago
skullY dff5708b07 update basic_how_keyboards_work 8 years ago
skullY 435f99916c Work around quoting hell 8 years ago
skullY b22220532f Rewrite mouse_keys to resolve #937 8 years ago
skullY 6b0503b20d update the faq 8 years ago
skullY 80cc23e912 fix the info boxes 8 years ago
skullY d8e29b53fe Update a bunch of docs 8 years ago
skullY ea8df568f2 reduce the TOC scope 8 years ago
skullY 486abde026 tweak page-toc settings 8 years ago
skullY 10b389f79c Adjust headings to make navigator happier 8 years ago
Jack Humbert 3e3c3e2b24 start glossary 8 years ago
Jack Humbert 9f643ba8bf clean-up github page 8 years ago
Jack Humbert 4c7e66c31c add file to summary 8 years ago
Jack Humbert b139633f89 adds how to github 8 years ago
skullY 7da94ac51b Fixup the gitbook config 8 years ago
skullY bf3007ec58 Add some gitboot plugins 8 years ago
skullY 409cb1af52 Polish up custom_quantum_functions 8 years ago
Jack Humbert b75ad215c8 use default base names 8 years ago
Jack Humbert 391eae97e4 testing out new home 8 years ago
Jack Humbert d59734d3b7 restructure summary 8 years ago
skullY 910d32c07e Flesh out the quantum_keycodes documentation 8 years ago
Jack Humbert d5244c6cf4 restructure keycode docs 8 years ago
Jack Humbert 40d82906cb adds config options md 8 years ago
skullY 617923cd56 Rough draft for a document on understanding QMK 8 years ago
Jack Humbert ea7590c894 add new arguements, docs 8 years ago
Jack Humbert 4ba9438c3f Add eclipse to the _summary 8 years ago
Jack Humbert 901a92a2fd Update _summary.md 8 years ago
Jack Humbert c208a6d4e5 update docs for isp 8 years ago
Jack Humbert 918aea5b47 Update _summary.md 8 years ago
Jack Humbert b4f2f44a6f Create isp_flashing_guide.md 8 years ago
Jack Humbert 2b98ec67f3 Update _summary.md 8 years ago
Jack Humbert 7b3c9cc8de Create adding_a_keyboard_to_qmk.md 8 years ago
Jack Humbert f32c68ee65 Update porting_your_keyboard_to_qmk.md 8 years ago
Jack Humbert 621ae42a6c revert edit 8 years ago
Jack Humbert 4217cb5bbc Update key_functions.md 8 years ago
Jack Humbert 6bd4df7a90 define limits to functions 8 years ago
Jack Humbert 06f0f92c1a Delete VAGRANT_GUIDE.md 8 years ago
Jack Humbert 7921834663 Delete USB_NKRO.txt 8 years ago
Jack Humbert d942389e11 Delete TMK_README.md 8 years ago
Jack Humbert 3df614c942 Delete POWER.txt 8 years ago
Jack Humbert 08fdced65f Delete PCB_GUIDE.md 8 years ago
Jack Humbert de4a38ab1b Delete Macros.md 8 years ago
Jack Humbert ceb7a63c68 Delete Kiibohd.asciidoc 8 years ago
Jack Humbert 656744e7dd Delete Keymap.md 8 years ago
Jack Humbert 6442822efd Delete Keycodes.md 8 years ago
Jack Humbert f320ac4bc6 Delete Home.md 8 years ago
Jack Humbert ee595965ae Delete HAND_WIRE.md 8 years ago
Jack Humbert 4de370ccc3 Delete FUSE.txt 8 years ago
Jack Humbert 4092e45b6b Delete FAQ.md 8 years ago
Jack Humbert 296e8669f3 Delete Embedding.md 8 years ago
Jack Humbert fa6044ab1d Delete Eclipse.md 8 years ago
Jack Humbert 401aab7d5a Delete CYGWIN_GUIDE.md 8 years ago
Jack Humbert 5e9d5a0a75 Delete BUILD_GUIDE.md 8 years ago
Jack Humbert 995c3141a6 convert docs to lowercase and underscores 8 years ago
Jack Humbert ca01d94005 convert docs to lowercase and underscores 8 years ago
Jack Humbert 558db0e03f remove leading slash 8 years ago
Jack Humbert 43b6179feb Merge branch 'master' into improve_macro_docs 8 years ago
Jack Humbert 163754f363 Create Home.md 8 years ago
Jack Humbert ad49086be5 Create SUMMARY.md 8 years ago
Jack Humbert 2f942c9883 Create Custom-Quantum-Functions.md 8 years ago
Jack Humbert 1da0a19177 make searchable 8 years ago
Jack Humbert 5801a1f8af update music docs 8 years ago
skullY a0ac0d3cea Move Dynamic Macros into their own file 8 years ago
skullY 767bcac23c Clean up and improve the macro documentation 8 years ago
Ethan Madden d9f95c5da9 Docfix (#1377)
* SCKLCK is now SCROLLLOCK

Yes, with all three Ls
At least it doesn't have a random K anymore lol

* Removed strange mystery trailing numbers in the docs
8 years ago
Erez Zukerman 481797f92f Documents permissive hold 8 years ago
Ethan Madden e82c089b4c SCKLCK is now SCROLLLOCK (#1376)
Yes, with all three Ls
At least it doesn't have a random K anymore lol
8 years ago
Jack Humbert eefec19ad9 Update Keycodes.md 8 years ago
Jack Humbert 47c209fa02 Update Keycodes.md 8 years ago
fabienheureux 19816a4998 Broken Keymap docs link 8 years ago
Jack Humbert 1d6a18db99 Merge pull request #1343 from Maartenwut/patch-1
Added SEND_STRING(); to the documentation.
8 years ago
Jack Humbert cecf783e14 Merge pull request #1337 from fredizzimo/wsl_setup
Add script for setting up Windows Subsystem for Linux
8 years ago
Maarten Dekkers 91c6113cba Added SEND_STRING(); to the documentation. 8 years ago
Damien 51e44fd6c5 Update Differences-from-TMK.md
Removed fn_actions.

According this [comment](https://github.com/qmk/qmk_firmware/pull/1336#issuecomment-304634633)
8 years ago
Fred Sundvik 78aebe0631 Update windows 10 instructions 8 years ago
Damien b2010cd478 Update Differences-from-TMK.md
Hello,

I'm not sure but it seems to be uint8_t for TMK/fn_actions (cf. https://github.com/tmk/tmk_keyboard/blob/master/README.md ).

Regards,
Damien
8 years ago
Fred Sundvik 623b1cd866 Fix line endings in FAQ.md 8 years ago
Jack Humbert c3bdddb637 move book for gitbook 8 years ago
Jack Humbert c95f08c439 Updates docs/book.json
Auto commit by GitBook Editor
8 years ago
Jack Humbert 7e84b0e3b3 move old doc to docs 8 years ago
Jack Humbert 704794bae3 subtree docs 8 years ago