summaryrefslogtreecommitdiff
path: root/users/greatwizard/readme.md
diff options
context:
space:
mode:
authorGuillaume Gรฉrard <1322081+GreatWizard@users.noreply.github.com>2020-10-28 18:20:06 +0100
committerGitHub <noreply@github.com>2020-10-28 10:20:06 -0700
commitc745cbb77a66a44549ee1ab3b1998c495c1a1ca5 (patch)
treea947f2215dcda13fac95b2620b70bc095b8d2d14 /users/greatwizard/readme.md
parent6b1ae7e6aa7180b00759b5692d2ea5bd0303c566 (diff)
[Keymap] greatwizard userspace and ortho 4x12 and 5x12 keymaps (#9584)
Diffstat (limited to 'users/greatwizard/readme.md')
-rw-r--r--users/greatwizard/readme.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/users/greatwizard/readme.md b/users/greatwizard/readme.md
new file mode 100644
index 0000000000..bc2df7f9bf
--- /dev/null
+++ b/users/greatwizard/readme.md
@@ -0,0 +1,32 @@
+# GreatWizard Userspace
+
+## Features
+
+- โŒจ๏ธ Switchable and persistent base layers: Qwerty, Workman, Workman, Colemak, Dvorak, ๐ŸŽฎ Game
+- โŒจ๏ธ Programmer flavored base layers available
+- ๐Ÿ’ƒ๐Ÿ•บ Tap Dances
+- ๐Ÿ†™ Auto Shift
+- ๐Ÿ‘จโ€๐Ÿ’ป One shot keys git commands layer
+- ๐ŸŒˆ RGB Underglow lights based on the layer
+- โš™๏ธ Rotary encoder for volume level and next/previous media
+- ๐Ÿ—œ๏ธ Enable link time optimization
+
+## Community Layouts
+
+- [ortholinear 4x12](https://github.com/qmk/qmk_firmware/tree/master/layouts/community/ortho_4x12/greatwizard)
+- [ortholinear 5x12](https://github.com/qmk/qmk_firmware/tree/master/layouts/community/ortho_5x12/greatwizard)
+
+## Build Options
+
+### Layers
+
+- `LAYERS_ORTHO`: add Lower, Raise and Adjust layers/keycodes
+- `LAYERS_PROGRAMMER`: add Programmer layers/keycodes
+- `LAYER_GAME`: add Game layer/keycode
+- `LAYER_GIT`: add GIT layer/keycode
+- `LAYER_FN`: add Fn layer/keycode
+
+### Tap Dances
+
+- `TAP_DANCE_LALT_GIT`: Double tap on LGUI to use the one shot keys git commands layer
+- `TAP_DANCE_LSFT_CAPS`: Double tap on LSHIFT to set Caps Lock