Commit Graph

242 Commits (a730cf6718919e89ed44f5e15f24b7c2022400a1)

Author SHA1 Message Date
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>
2017-11-21 00:20:52 -05:00
Gilbert Consellado 7ff96877d2 added SS_LSFT to featured macros 2017-11-20 12:25:42 -05:00
Balz Guenat 858c09f370 add example keymap 2017-11-16 09:39:00 -05:00
Balz Guenat 179d64d33c extend macro docs a bit 2017-11-16 09:39:00 -05:00
drashna 3c15c48e6a Add "KC_MAKE" to userspace example 2017-11-14 11:02:00 -05:00
James 309a400b3e Update hand_wire.md
Change "Resin" to "Rosin"
2017-11-13 18:48:55 -05:00
Erin Call 392121b10e Document the Teensy hardware reset problem 2017-11-12 11:51:12 -05:00
skullY 4df4fa7c26 Clarify `KC_PWR` vs `KC_POWER`. Fixes #1994. 2017-11-10 17:58:32 -05:00
skullY 66f13e4972 Move keycodes to their own section 2017-11-10 17:58:32 -05:00
Jack Humbert bb11df6b7a update some docs 2017-11-09 16:19:13 -05:00
Zach Burchill e236f1eba1 Fixed some grammar and typos on the docs (#1989)
* fixed grammar and references

* fixed typo
2017-11-09 16:18:31 -05:00
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.
2017-11-06 12:09:01 -05:00
Jeremy Cowgar 245b3376d6 Correct the rules.mk documentation for auto shift.
fixes #1965
2017-11-06 12:03:36 -05:00
skullY 535c2f60a9 use real greater than and less than chars 2017-11-02 16:27:17 -07:00
skullY 432674781a Document info.json files 2017-11-02 01:31:02 -07:00
skullY 4e41beeaa6 Fix a typo 2017-11-02 01:30:51 -07:00
Jack Humbert 00733f4b87 update contributing guidelines 2017-11-01 21:42:05 -04:00
Jack Humbert d069a42c07
Update getting_started_github.md 2017-11-01 14:10:28 -04:00
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
2017-11-01 11:21:54 -04:00
Jack Humbert 38261920a9
update hand wiring link 2017-10-31 13:38:57 -04:00
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
2017-10-31 11:15:22 -04:00
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.
2017-10-31 00:40:27 -04:00
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. 2017-10-29 20:04:10 -04:00
Jeremy Cowgar 76d807fe7d Fix code example in auto shift docs 2017-10-29 20:04:10 -04:00
Jeremy Cowgar bf1fedc05e Fixed various feature links 2017-10-29 20:04:10 -04:00
Jack Humbert 4d421ee31c adds flashing docs 2017-10-29 18:44:29 -04:00
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
2017-10-24 20:34:28 -07:00
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.
2017-10-24 17:02:20 -10:00
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
2017-10-21 18:24:06 -10:00
Jack Humbert 06f196c589 Creates a userspace for keymaps (#1559)
* create a user space

* adds example

* document, add readme.md

* jackhumbert userspace, ergodox keymap
2017-10-21 11:44:11 -10:00
skullY 9bb259b660 Fix the naming for clueboard files 2017-10-21 13:51:18 -07:00
James 3276c4c56a Minor punctuation and grammar edits. 2017-10-21 10:02:14 -10:00
Jason Milkins 78923cb884 Fix code backticks on Frequently Asked Build Questions docs 2017-10-21 09:58:48 -10:00
Jason Milkins a860d9d628 Fix missing code backticks 2017-10-21 09:58:17 -10:00
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
2017-10-18 17:14:12 -10:00
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
2017-10-17 16:47:49 -07:00
Dylan Khor aa660c1eb7 Broken link found in issue #1845 2017-10-15 15:03:23 -10:00
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
2017-10-14 11:32:19 -10:00
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.
2017-10-12 06:25:47 -10:00
skullY db5afb05cf Fix the presentation of the contribution guide 2017-10-11 12:18:53 -07:00
skullydazed 2db4ad2133 Write a contributing guide. (#1827) 2017-10-11 12:07:15 -07:00
Jesper Brix Rosenkilde 966e2660cf Add option to reverse PS2 mouse axes and scrolling 2017-10-10 07:20:17 -10:00
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
2017-10-10 07:07:59 -10:00
lyuts d8c62e4238 Fixed typo in docs. (#1818) 2017-10-06 20:15:55 -07:00
Snipeye ee13228486 Generic Pointing Device (#1767) 2017-10-06 07:13:08 -10:00
Dylan Khor 0cc62459a7 Minor typo 2017-10-05 07:22:25 -10:00
Sebastian Kaim 29bcffb3f3 Edited a minor typo in feature_bootmagic.md. 2017-10-05 06:17:34 -10:00
Daniel Gordon 03de0c8575 Reference to rules.mk in tap dance docs added
Change-Id: I64aa6f95a30ab05f0ed3f499e54b9e125d379fad
2017-10-03 09:04:31 -10:00
Max Riveiro f1451b4b04 Fix HSV Color Wheel image on RGB Light page (#1773)
Signed-off-by: Max Riveiro <kavu13@gmail.com>
2017-09-29 16:19:15 -07:00
Lukas Werling 1ad941e984 Add shell.nix for NixOS users 2017-09-25 13:14:20 -04:00
Zach Burchill 809c9258c1 Fixed typo of "multually" to "mutually" 2017-09-25 13:08:06 -04:00
surlyjake c8d365f5da platform descriptions to match master keycodes.md documentation 2017-09-25 13:07:46 -04:00
surlyjake 957e44231a updated keycodes media descriptions
Platform compatibility descriptions added for mute, volume up/down
2017-09-25 13:07:46 -04:00
Jeremy Cowgar a89183591c Fixed a few typos and spelling errors in auto shift feature document 2017-09-18 17:08:18 -04:00
Jeremy Cowgar abba393f57 Added Auto Shift, tap key = normal, hold key = shifted state. 2017-09-18 17:08:18 -04:00
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
2017-09-12 00:43:10 -04:00
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
2017-09-08 13:47:50 -04:00
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
2017-09-06 14:49:19 -07:00
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.
2017-09-06 10:36:47 -07:00
Jack Humbert 5f154f0a00 Update feature_common_shortcuts.md 2017-09-05 13:11:43 -04:00
Marco Fontani da83f04a30 add UC_OSX_RALT to make unicode use the Right Alt key on OSX 2017-08-30 11:38:03 -04:00
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
2017-08-23 22:29:07 -04:00
Joe Wasson bdc0880ca5 Add compile error if too many endpoints are defined for the ATmega32U4. 2017-08-20 11:51:57 -04:00
Jack Humbert 5cab5e4a4e validates json 2017-08-19 08:35:14 -04:00
Jack Humbert d8145c8464 adds redirects for docs 2017-08-19 08:31:54 -04:00
Joe Wasson 94ca84d271 Fix incorrect name for GeminiPR in docs. 2017-08-18 14:43:24 -04:00
Jack Humbert 52f2f6d8ea adds audio docs to summary 2017-08-18 13:57:57 -04:00
Benny Powers 9fed4f7948 Add link to keycodes doc in how_keyboards_work 2017-08-18 12:49:55 -04:00
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.
2017-08-18 00:18:04 -07:00
Jack Humbert b483a90a90 update favicons 2017-08-17 17:13:44 -04:00
skullY f02430b131 Update links in the glossary 2017-08-16 15:47:20 -04:00
skullY 9d1a08e38a Doc updates from going through every file 2017-08-16 15:47:20 -04:00
skullY 9b879b1267 break up keymaps and quantum keycodes into files by feature 2017-08-16 15:47:20 -04:00
skullY 2709744cdd take a stab at documenting layers 2017-08-16 15:47:20 -04:00
skullY 207bcd788a rework key_functions into feature_common_shortcuts 2017-08-16 15:47:20 -04:00
skullY e6c638bed1 Overhaul the Getting Started section and add a FAQ section 2017-08-16 15:47:20 -04:00
discursivemoth b7d43ee253 correct tilde to grave 2017-08-15 19:48:58 -04:00
Balz Guenat 430151dd51 Merge remote-tracking branch 'upstream/master'
# Conflicts:
#	docs/faq_keymap.md
2017-08-12 12:14:33 +02:00
Balz Guenat 175db1a549 fix code block formatting 2017-08-11 23:13:50 +02:00
Balz Guenat 5ad103fa51 add description of new option to docs and add option (commented out) into template. 2017-08-11 16:54:10 -04:00
Balz Guenat 3e67cc9c80 add description of new option to docs and add option (commented out) into template. 2017-08-11 22:20:36 +02:00
Danny Nguyen f1536a3f54 Change installation of avr-libc to avr-gcc, now that avr-libc is integrated into the avr-gcc build 2017-08-08 10:03:19 -04:00
Fredric Silberberg a3e1d9a8cc Added support for locking One Shot modifiers. 2017-08-08 10:02:53 -04:00
Fredric Silberberg 5fc4a664dc Added initial key lock documentation. 2017-08-08 10:02:53 -04:00
Jack Humbert 9e79bb1491 Merge pull request #1554 from qmk/docs
Updates some remaining doc stuff
2017-08-06 22:29:59 -04:00
Balz Guenat 525b3deadf add short name for locking mods to docs. 2017-08-03 23:10:31 -04:00
Balz Guenat 07ba06d0b6 fix section in porting guide that refered to Makefile instead of rules.mk 2017-08-02 22:00:49 -04:00
Joe Wasson c5780647d8 Fix typo in docs. 2017-07-27 16:10:36 -04:00
Joe Wasson 26fb063be3 Link to steno docs from summary page. 2017-07-27 16:10:36 -04:00
Joe Wasson c0f63ca9dc Add documentation for Steno. 2017-07-27 16:10:36 -04:00
Jack Humbert cefc09ae7d adds option for alt pitch standards 2017-07-24 12:45:34 -04:00
Joe Wasson a543ad4c1d Fix minor formatting issue. 2017-07-23 15:10:27 -04:00
Jack Humbert 6bdf7482b1 update audio/music documentation 2017-07-23 14:59:29 -04:00
Jack Humbert 9abbbe7089 update audio documentation 2017-07-23 14:59:29 -04:00
Jack Humbert f407f3e8de remove unneccesary headers 2017-07-23 14:59:29 -04:00
Jack Humbert fe113ebad5 start updating audio docs 2017-07-23 14:59:29 -04:00
Jack Humbert 14c5160b1a Update _summary.md 2017-07-17 15:01:33 -04:00
Jack Humbert 000e749853 Rename docs/features/README.md to docs/features.md 2017-07-17 15:01:11 -04:00
Erez Zukerman 585f140052 Invites contributions 2017-07-10 20:51:46 -04:00
skullY 4c7c7747a3 Add terminal examples to doc best practices 2017-07-08 22:39:17 -07:00