]> git.donarmstrong.com Git - qmk_firmware.git/blobdiff - keyboards/alu84/keymaps/TurboMech/readme.md
added ALU84 keyboard and TurboMech user space (#2206)
[qmk_firmware.git] / keyboards / alu84 / keymaps / TurboMech / readme.md
diff --git a/keyboards/alu84/keymaps/TurboMech/readme.md b/keyboards/alu84/keymaps/TurboMech/readme.md
new file mode 100644 (file)
index 0000000..b78d7a5
--- /dev/null
@@ -0,0 +1,93 @@
+# This is u/TurboMech's keyboard layout for ALU84.  
+
+## It is designed for Mac OS, due to the specific functions I created.  
+
+### Here is the layout found in the keymap.c file.
+#####  I use shortcuts for the Function row (above number row) listed below
+  - Scrn Bright Up: F14
+  - Scrn Bright Down: F15
+  - Expose: LCTRL + Up 
+  - Launchpad: LCTRL + L
+  - Show Desktop: F11
+  - Show/Hide Dock: LALT + LGUI + D
+  - Screen Capture: LCTRL + S
+  - Custom Shortcut (setup for an application I use frequently): LCTRL + LSHFT + O
+  - Custom Shortcut 1: LCTRL + LGUI + 1
+  - Custom Shortcut 2: LCTRL + LGUI + 2
+  - Custom Shortcut 3: LCTRL + LGUI + 3 
+    - use the custom shortcuts for whatever you want: launch an application, a macro, etc.
+  - Play/Pause: exactly that
+  - Mute / Volume Up / Volume Down: exactly what it says
+
+ ##### Going down the right side from Vol Down:
+  - POWER: this serves as the power button on Mac's only.  Press and hold the button as you would on your Macbook or iMac keyboard.
+  - Menu: this slides the notification bar on the right side (its the same as on iPhones/ iPads) 
+
+### See below keymaps for how to setup shortcuts on Mac
+
+#### Base Layer
+```
+.- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -. 
+|   Esc   |   Scrn  |   Scrn  | Expose  |Launchpad|   Show  |Dock Hide|  Screen | Shortcut| Shortcut| Shortcut| Shortcut|   Play  |  Mute   | Vol Up  | Vol Down|
+|         |Brght Up | Brght Dn|         |         | Desktop |  Toggle | Capture |         |         |         |         |   Pause |         |         |         |
+|- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - - - - - - -+- - - - -|
+|    `    |    1    |    2    |    3    |    4    |    5    |    6    |    7    |    8    |    9    |    0    |    -    |    +    |     Backspace     |  POWER  | 
+|         |         |         |         |         |         |         |         |         |         |         |         |         |                   |         |
+|- - - - - - - +- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - - - - +- - - - -|
+|     TAB      |    Q    |    W    |    E    |    R    |    T    |    Y    |    U    |    I    |    O    |    P    |    [    |     ]   |      \       | Shortcut|
+|              |         |         |         |         |         |         |         |         |         |         |         |         |              |         |
+|- - - - - - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - - - - - - - -+- - - - -|
+|      CAPS       |    A    |    S    |    D    |    F    |    G    |    H    |    J    |    K    |    L    |    ;    |    '    |        Enter        |   Page  |
+|                 |         |         |         |         |         |         |         |         |         |         |         |                     |    Up   |
+|- - - - - - - - - - - +- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - - - - - +- - - - -+- - - - -+
+|        Shift         |    Z    |    X    |    C    |    V    |    B    |    N    |    M    |    ,    |    .    |    /    |     Shift      |   Up    |  Page   |
+|                      |         |         |         |         |         |         |         |         |         |         |                |         |  Down   |
+|- - - - - +- - - - - - +- - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -|
+|  Control |   Option   |     Gui    |                             Space                            |   Gui   |   Opt   |    Fn   |  Left   |   Down  |  Right  |
+|          |    /Alt    |            |                                                              |         |   Alt   |         |         |         |         |
+'- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -'
+```
+#### Function Layer 1 - See above for shortcuts
+```
+.- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -.
+|   Quit  |   F1    |    F2   |   F3    |   F4    |   F5    |    F6   |   F7    |    F8   |    F9   |   F10   |   F11   |   F12   |  Trns   |  Trns   |   DFU   |
+|   All   |         |         |         |         |         |         |         |         |         |         |         |         |         |         |  Reset  |
+|- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - - - - - - -+- - - - -|
+|   Trns  |   Trns  |   Trns  |   Trns  |   Trns  |   Trns  |   Trns  |   Trns  |   Trns  |   Trns  |   Trns  |   Trns  |   Trns  |       Delete      |   Lock  | 
+|         |         |         |         |         |         |         |         |         |         |         |         |         |                   |Shortcut |
+|- - - - - - - +- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - - - - +- - - - -|
+|     Trns     |   RGB   |   RGB   |   RGB   |   RGB   | RGB Hue | RGB Hue | RGB Sat | RGB Sat |  Trns   |   Trns  |   Trns  |   Trns  |     Trns     |   Trns  | 
+|              |  Toggle |   Mode  | Increase| Decrease| Increase| Decrease| Increase| Decrease|         |         |         |         |              |         |
+|- - - - - - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - - - - - - - -+- - - - -|
+|      Trns       |   Trns  |   Trns  |   Trns  |   Trns  |   Trns  |  Trns   |  Trns   |   Trns  |   Trns  |  Trns   |   Trns  |        Trns         |   Trns  |
+|                 |         |         |         |         |         |         |         |         |         |         |         |                     |         |
+|- - - - - - - - - - - +- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - - - - - +- - - - -+- - - - -+
+|         Trns         |Backlight|Backlight|Backlight|Backlight|   Trns  |  Trns   |   Trns  |   Trns  |   Trns  |   Trns  |     Trns       |  Trns   |  Trns   |
+|                      |  Toggle | Increase| Decrease|   Step  |         |         |         |         |         |         |                |         |         |
+|- - - - - +- - - - - - +- - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -+- - - - -|
+|   Trns   |    Trns    |    Trns    |                             Trns                             |  Trns   |  Trns   |  Trns   |  Trns   |   Trns  |  Trns   |
+|          |            |            |                                                              |         |         |         |         |         |         |
+'- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -'
+```
+
+#### How to use/ setup shortcuts on Mac
+- First navigate to System Preferences > Keyboard > Shortcuts
+  - You can use any of them in here
+  - Just set them to the shortcut keys listed above
+
+#### How to make your own (to launch applications, quit all, etc.)
+- Navigate to Automator > New Document > click Service > Choose
+- Now we have to setup our shortcut
+  - Here's how to setup the Quit All Shortcut
+    - In the right window select the Service recieves dropdown > select No Input
+    - At the top left click the Name (Search) > type quit > click and hold Quit All Applications > drag to the right hand box (under the Service Recieves) 
+      - **IMPORTANT** You have to click the Run button at the upper right hand corner in order for these to actually work. 
+    - Now click File > Save > save it as Quit All Apps (or whatever you want) / you can also just exit out and it'll ask you if you want to save
+- Navigate back to System Preferences > Keyboard > Shortcuts
+    - The new shortcut can be found under services, set it to one of the shortcuts I listed above and done
+- The same applies for applications in the Name (search) just type the application you want to have as shortcut. Don't forget to run it, then do the same steps
+  to set it up as a shortcut.
+
+
+
+