diff options
Diffstat (limited to 'docs/feature_auto_shift.md')
| -rw-r--r-- | docs/feature_auto_shift.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/feature_auto_shift.md b/docs/feature_auto_shift.md index fdd10ada9..8d59d4573 100644 --- a/docs/feature_auto_shift.md +++ b/docs/feature_auto_shift.md | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | # Auto Shift: Why do we need a shift key? | 1 | # Auto Shift: Why Do We Need a Shift Key? |
| 2 | 2 | ||
| 3 | Tap a key and you get its character. Tap a key, but hold it *slightly* longer | 3 | Tap a key and you get its character. Tap a key, but hold it *slightly* longer |
| 4 | and you get its shifted state. Viola! No shift key needed! | 4 | and you get its shifted state. Viola! No shift key needed! |
| @@ -10,7 +10,7 @@ fingers repetitively long distances. For us on the keyboard, the pinky does that | |||
| 10 | all too often when reaching for the shift key. Auto Shift looks to alleviate that | 10 | all too often when reaching for the shift key. Auto Shift looks to alleviate that |
| 11 | problem. | 11 | problem. |
| 12 | 12 | ||
| 13 | ## How does it work? | 13 | ## How Does It Work? |
| 14 | 14 | ||
| 15 | When you tap a key, it stays depressed for a short period of time before it is | 15 | When you tap a key, it stays depressed for a short period of time before it is |
| 16 | then released. This depressed time is a different length for everyone. Auto Shift | 16 | then released. This depressed time is a different length for everyone. Auto Shift |
| @@ -20,7 +20,7 @@ when you release the key. If the time depressed is greater than or equal to the | |||
| 20 | `AUTO_SHIFT_TIMEOUT`, then a shifted version of the key is emitted. If the time | 20 | `AUTO_SHIFT_TIMEOUT`, then a shifted version of the key is emitted. If the time |
| 21 | is less than the `AUTO_SHIFT_TIMEOUT` time, then the normal state is emitted. | 21 | is less than the `AUTO_SHIFT_TIMEOUT` time, then the normal state is emitted. |
| 22 | 22 | ||
| 23 | ## Are there limitations to Auto Shift? | 23 | ## Are There Limitations to Auto Shift? |
| 24 | 24 | ||
| 25 | Yes, unfortunately. | 25 | Yes, unfortunately. |
| 26 | 26 | ||
| @@ -38,7 +38,7 @@ Yes, unfortunately. | |||
| 38 | tapping the keys, but really we have held it for a little longer than | 38 | tapping the keys, but really we have held it for a little longer than |
| 39 | anticipated. | 39 | anticipated. |
| 40 | 40 | ||
| 41 | ## How do I enable Auto Shift? | 41 | ## How Do I Enable Auto Shift? |
| 42 | 42 | ||
| 43 | Add to your `rules.mk` in the keymap folder: | 43 | Add to your `rules.mk` in the keymap folder: |
| 44 | 44 | ||
| @@ -66,7 +66,7 @@ A sample is | |||
| 66 | 66 | ||
| 67 | #endif | 67 | #endif |
| 68 | 68 | ||
| 69 | ### AUTO_SHIFT_TIMEOUT (value in ms) | 69 | ### AUTO_SHIFT_TIMEOUT (Value in ms) |
| 70 | 70 | ||
| 71 | This controls how long you have to hold a key before you get the shifted state. | 71 | This controls how long you have to hold a key before you get the shifted state. |
| 72 | Obviously, this is different for everyone. For the common person, a setting of | 72 | Obviously, this is different for everyone. For the common person, a setting of |
| @@ -86,7 +86,7 @@ quick. See "Auto Shift Setup" for more details! | |||
| 86 | 86 | ||
| 87 | ### NO_AUTO_SHIFT_SPECIAL (simple define) | 87 | ### NO_AUTO_SHIFT_SPECIAL (simple define) |
| 88 | 88 | ||
| 89 | Do not Auto Shift special keys, which include -_, =+, [{, ]}, ;:, '", ,<, .>, | 89 | Do not Auto Shift special keys, which include -\_, =+, [{, ]}, ;:, '", ,<, .>, |
| 90 | and /? | 90 | and /? |
| 91 | 91 | ||
| 92 | ### NO_AUTO_SHIFT_NUMERIC (simple define) | 92 | ### NO_AUTO_SHIFT_NUMERIC (simple define) |
| @@ -134,7 +134,7 @@ completely normal and with no intention of shifted keys. | |||
| 134 | 9. Remove the key bindings `KC_ASDN`, `KC_ASUP` and `KC_ASRP`. | 134 | 9. Remove the key bindings `KC_ASDN`, `KC_ASUP` and `KC_ASRP`. |
| 135 | 10. Compile and upload your new firmware. | 135 | 10. Compile and upload your new firmware. |
| 136 | 136 | ||
| 137 | #### An example run | 137 | #### An Example Run |
| 138 | 138 | ||
| 139 | hello world. my name is john doe. i am a computer programmer playing with | 139 | hello world. my name is john doe. i am a computer programmer playing with |
| 140 | keyboards right now. | 140 | keyboards right now. |
| @@ -155,4 +155,4 @@ completely normal and with no intention of shifted keys. | |||
| 155 | 155 | ||
| 156 | The keyboard typed `115` which represents your current `AUTO_SHIFT_TIMEOUT` | 156 | The keyboard typed `115` which represents your current `AUTO_SHIFT_TIMEOUT` |
| 157 | value. You are now set! Practice on the *D* key a little bit that showed up | 157 | value. You are now set! Practice on the *D* key a little bit that showed up |
| 158 | in the testing and you'll be golden. \ No newline at end of file | 158 | in the testing and you'll be golden. |