summaryrefslogtreecommitdiff
path: root/keyboards/kbdfans/kbd75/keymaps/aaronireland/readme.md
diff options
context:
space:
mode:
authorAaron Ireland <aarireland@me.com>2021-01-19 22:05:23 -0500
committerGitHub <noreply@github.com>2021-01-19 19:05:23 -0800
commit45bec2d28170ccc20a04610b0294f1d6cbfed283 (patch)
treec9b2bcfe3ee2f4596d63ecd04f83b5ab05c58741 /keyboards/kbdfans/kbd75/keymaps/aaronireland/readme.md
parenteba512596a0e7845b9cf7efdad19b820e9974e00 (diff)
[Keymap] Mac-friendly KBD 75% layouts (#11507)
* Add Aaron's KBD75 v2 for Macbook * Add Colemak & Dvorak layers * Update keymap to adhere to style guide and add license * Rename README.md to readme.md
Diffstat (limited to 'keyboards/kbdfans/kbd75/keymaps/aaronireland/readme.md')
-rw-r--r--keyboards/kbdfans/kbd75/keymaps/aaronireland/readme.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/keyboards/kbdfans/kbd75/keymaps/aaronireland/readme.md b/keyboards/kbdfans/kbd75/keymaps/aaronireland/readme.md
new file mode 100644
index 0000000000..aac4d17968
--- /dev/null
+++ b/keyboards/kbdfans/kbd75/keymaps/aaronireland/readme.md
@@ -0,0 +1,39 @@
+# Aaron's KBD75v2 Mac-friendly ANSI 1u Layout
+
+This layout mimics the default KBD 75% ANSI 1u layout with a few mac-friendly tweaks. Because Mac OS uses a unique keycode
+for the Function key and only recognizes that keycode from keyboards registered with an Apple vendor ID ([see here for more info](https://beta.docs.qmk.fm/faqs/faq_keymap#fn-key-on-macos)),
+this layout uses custom macros and F-keycodes (F12, F13, etc) to provide Mac hotbar functionality (Print Screen, Launchpad, etc...) and maps the
+**Fn** key to the QMK momentary layer `_FN` (layer index 3) so it is listed as `MO(3)`.
+
+| Mac OS Keystroke | Description | User-defined Macro | Layout Mapping |
+| ---------------- | ------------------------ | ------------------ | ---------------- |
+| ⌘ + Shift + 3 | Print Screen | `KC_CAPW` | `Prt Scn` |
+| ⌘ + Shift + 4 | Print Screen (selection) | `KC_CAPP` | `fn` + `Prt Scn` |
+| F13 | Launchpad | | `fn` + `Home` |
+| | Colemak | `COLEMAK` | `fn` + `C` |
+| | Dvorak | `DVORAK` | `fn` + `D` |
+| | Qwerty | `QWERTY` | `fn` + `Q` |
+| `Ctrl` + `C` | Quit/Break | `KC_CTLC` | `Pse Brk` |
+| `Ctrl` + `B` | vim page up | `KC_SPU` | `fn` + `Pg Up` |
+| `Ctrl` + `D` | vim page down | `KC_SPD` | `fn` + `Pg Dn` |
+
+<br>
+<hr>
+
+### QWERTY - Layer 0
+
+![Layer 0: QWERTY](https://i.imgur.com/haydhHS.png)
+
+### FUNCTION - Layer 3
+
+![Layer 3: FUNCTION](https://i.imgur.com/XHUvgLd.png)
+
+<br><br><hr>
+
+### COLEMAK - Layer 1
+
+![Layer 1: COLEMAK](https://i.imgur.com/sBfHH8K.png)
+
+### DVORAK - Layer 2
+
+![Layer 2: DVORAK](https://i.imgur.com/AaypaN4.png)