document general info and OS X programming

Author: davidjenni

README.md

@@ -1,2 +1,56 @@
-# pok3r-layouts
-POK3R keyboard layouts for Windows and OS X/Mac
+# POK3R keyboard layouts for Windows and OSX
+
+The default layer is not configurable in the POK3R keyboard, so I chose the following layers to use this keyboard in either OS:
+* Windows: Layer 2 (blue LED), switch to it with: `FN + ,<`
+* OSX: Layer 3 (red LED), switch with: `FN + .>`
+
+## General POK3R programming info
+* POK3R User Manual](http://www.vortexgear.tw/db/upload/webdata4/vortex_20156296454697283.pdf) on Vortex's site
+* Factory reset: Hold both the left and right `ALT` keys
+* Reset selected layer only: `FN + R` until LED under spacebar stops flashing
+
+### Programming of layers 2-4:
+* Default layer cannot be programmed
+* `FN + R_Ctrl`  (use `L_Ctrl` if `FN` has been reassigned already) -> second LED under space bar is now lit
+* hit `target key`, then: `new content` (can be up to 32 char), then: `PN` (second LED will blink while programming)
+* `FN + R_Ctrl` to exit programming -> second LED extinguishes
+* During programming, use the keys as labelled on the keyboard, irrespective of any reassignments
+
+## Layer 3 (Red) for OSX:
+`FN + .` to switch to Layer  3
+* `FN + R_Ctrl` to enter programming
+* CapsLock always as Ctrl:
+  * `CapsLock` then: `L_Ctrl` then: `PN` to confirm
+  * `FN + CapsLock` then: `L_Ctrl` then: `PN` to confirm
+* VIM like HJKL and Page Up/Down:
+  * Left: `FN + H` then: `FN + J` then: `PN`
+  * Down: `FN + J` then: `FN + K` then: `PN`
+  * Up: `FN + K` then: `FN + I` then: `PN`
+  * PgDown: `FN + F` then: `FN + O` then: `PN`
+  * PgUp: `FN + B` then: `FN + U` then: `PN`
+  * Home: `FN + I` then: `FN + H` then: `PN`
+* Volume controls:
+  * Mute: `FN + X` then: `FN + /?` then: `PN`
+  * Vol-: `FN + C` then: `FN + ,<` then: `PN`
+  * Vol+: `FN + V` then: `FN + .>` then: `PN`
+* Swap Cmd/Opt keys on both sides of space bar:
+  * L_Cmd: `L_Alt` then: `L_WIN` then: `PN`
+  * L_Option: `L_WIN` then: `L_Alt` then: `PN`
+  * R_CMD: `R_Alt` then: `R_FN` (Win) then: `PN`
+  * R_Option: `R_FN` (Win) then: `R_Alt` then: `PN`
+* FN + R_Ctrl to exit programming
+Resulting programming:
+(http://www.keyboard-layout-editor.com/#/layouts/e382fdeb70646d636f373933462f2c75)
+
+## Move FN to L_Ctrl:
+* Switch to Layer 2 (or 3, 4); this programming is per layer
+* Unplug keyboard
+* DIP switch 4 to ON
+* Plugin keyboard again, then press `FN` then: `L_Ctrl` then: `PN` then: `PN` (to leave it in its original location)
+* DIP switch 4 back to OFF (no need to unplug)
+
+The how-to for these mappings is from 2 reddit thread:
+* [r/mk: HowTo program pok3r](http://www.reddit.com/r/MechanicalKeyboards/comments/35uy60/guide_howto_program_your_pok3r_programming_layers/)
+* [r/mk: HowTo media controls pok3r](http://www.reddit.com/r/MechanicalKeyboards/comments/37j3sx/guide_modification_pok3r_media_volume_controls_hw/)
+
+