summaryrefslogtreecommitdiffstats
path: root/docs/feature_space_cadet_shift_enter.md
diff options
context:
space:
mode:
authorfauxpark <fauxpark@gmail.com>2018-08-02 01:43:54 +1000
committerDrashna Jaelre <drashna@live.com>2018-08-01 08:43:54 -0700
commit03ad6927cba0698926542dd4f866d910f360e51d (patch)
treeabce2bffdc4c4c6839e5aa8ac0494abe7ac0faab /docs/feature_space_cadet_shift_enter.md
parentff14028bd8761f8935b7782208345b42a18b018c (diff)
Docs: Format Space Cadet documentation (#3540)
* Format Space Cadet documentation * Fix page filenames * Move Caveats section up
Diffstat (limited to 'docs/feature_space_cadet_shift_enter.md')
-rw-r--r--docs/feature_space_cadet_shift_enter.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/feature_space_cadet_shift_enter.md b/docs/feature_space_cadet_shift_enter.md
new file mode 100644
index 0000000000..56a569b139
--- /dev/null
+++ b/docs/feature_space_cadet_shift_enter.md
@@ -0,0 +1,31 @@
+# Space Cadet Shift Enter
+
+Based on the [Space Cadet Shift](feature_space_cadet_shift.md) feature. Tap the Shift key on its own, and it behaves like Enter. When held, the Shift functions as normal.
+
+## Usage
+
+Replace any Shift key in your keymap with `KC_SFTENT` (Shift, Enter), and you're done.
+
+## Keycodes
+
+|Keycode |Description |
+|-----------|----------------------------------------|
+|`KC_SFTENT`|Right Shift when held, Enter when tapped|
+
+## Caveats
+
+As with Space Cadet Shift, this feature may conflict with Command, so it should be disabled in your `rules.mk` with:
+
+```make
+COMMAND_ENABLE = no
+```
+
+This feature also uses the same timers as Space Cadet Shift, so using them in tandem may produce strange results.
+
+## Configuration
+
+By default Space Cadet assumes a US ANSI layout, but if you'd like to use a different key for Enter, you can redefine it in your `config.h`:
+
+|Define |Default |Description |
+|------------|--------|------------------------------------------------|
+|`SFTENT_KEY`|`KC_ENT`|The keycode to send when the Shift key is tapped|