summaryrefslogtreecommitdiff
path: root/keyboards/preonic
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/preonic')
-rw-r--r--keyboards/preonic/keymaps/CMD-Preonic/README.md78
1 files changed, 77 insertions, 1 deletions
diff --git a/keyboards/preonic/keymaps/CMD-Preonic/README.md b/keyboards/preonic/keymaps/CMD-Preonic/README.md
index 91fa4adeb9..2b80c2b3a6 100644
--- a/keyboards/preonic/keymaps/CMD-Preonic/README.md
+++ b/keyboards/preonic/keymaps/CMD-Preonic/README.md
@@ -1 +1,77 @@
-# CMD-Preonic - This keymapping aims to increase productivity, specifically for programmer's who use Text editors like SublimeText and Atom by maximizing usage of the left-hand and function layers.
+CMD-Preonic
+===================
+The CMD project seeks to improve productivity by optimizing usage of the left hand via clever use of the function layers.
+
+>Note: This project is currently optimized for grid layout, and has not been confirmed to work 100% on MIT layout, although it is expected to work correctly.
+
+----------
+
+Modes
+-------------
+
+#### QWERTY
+
+>CMD-Qwerty is very similar to the default Preonic with a few key differences:
+
+ - Dual-role Raise/Enter Key at Caps Lock position. -Don't need to take your hand off the mouse to submit URLs
+ - Space_Function under left space (Grid layout) -Don't need to take your thumb off of the spacebar to use lower.
+ - Dedicated arrow keys replaced with ( - , = , [ , and ] ) - big improvement for programmers who are used to fn layer.
+
+----------
+
+#### Game
+
+> Disables extra features to facilitate easier usage of the Preonic while gaming. this mode is toggled in the adjust layer.
+
+ - Dual Role Function key becomes Caps Lock.
+ - Space_Function disabled and replaced with normal spacebar.
+ - Windows Key disabled.
+
+----------
+
+#### Numpad
+
+> Enables left-hand numpad
+
+ - Left-side numpad
+ - Can be toggled on in Adjust layer (under . key)
+
+----------
+
+#### Arrow - (Lower)
+
+> Makes arrow keys easily accessible to Left Hand, and much more.
+
+ - Arrow keys at WASD, Backspace at Q, Delete at E.
+ - Media Keys near arrow cluster, mute at A.
+ - Web Nav keys.
+ - Mouse cluster at YGHJ.
+ - Numpad in right side of board.
+ - Can be toggled on in Adjust layer (Under , key)
+
+----------
+
+#### Function- (Raise)
+
+> Basic Functions. Open Keys for customization.
+
+ - Turns WASD into Navigation cluster (Home, End, Page up and Page Down)
+ - Pok3r style right hand arrow cluster for accessibility (familiar for many users.)
+ - Doubles as shift key for top row numbers.
+ - Print Screen, Insert, etc.
+
+----------
+
+#### Adjust- (Raise + Lower)
+
+> Switch Modes
+
+ - Default modes moved to the left and new layer toggle modes located to the right.
+ - Sleep and Wake keys added.
+ - Reset button moved under Spacebar(s).
+
+Notes:
+-------------
+
+Please feel free to reach out to Commandlinedesign@gmail.com with suggestions.
+Special Thanks to Jack for QMK firmware and the Preonic!