summaryrefslogtreecommitdiffstats
path: root/keyboards/gray_studio/space65/keymaps/billiams/readme.md
diff options
context:
space:
mode:
authorJames Young <18669334+noroadsleft@users.noreply.github.com>2020-01-18 17:00:09 -0800
committerGitHub <noreply@github.com>2020-01-18 17:00:09 -0800
commiteaed517c0bfb10c9169457ba2a187c0c4b0eef2e (patch)
tree7bd12e3e3a8ea14fa6b54005ee71fc38c1738108 /keyboards/gray_studio/space65/keymaps/billiams/readme.md
parentba628a28bcf09421739922d8eeef05e6ca9e9b6b (diff)
parentdff4f13c195ff8b799e886ec671d40d1448b55b9 (diff)
Added keymap for Space65 (#7562)
* Initial commit * Modified keymap and updated readme. * fixed numbering in readme * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Made requested changes in PR. * Rename README.md to readme.md * swapped media control keys * updated right alt key to apply shift key for emacs * updated R_Alt to remove shift * Updated readme * add layout 2 and rename existing folder to layout 4 - renamed existing folder with directional layout to layout 4 - udpated existing readme - Added layout_60_2 * update flash script per pull request review * Added keymap profile to space65 - This keymap profile is for MacOS with VIM key bindings - See readme for more information * Update keyboards/gray_studio/space65/keymaps/billiams/readme.md Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/gray_studio/space65/keymaps/billiams/readme.md Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/gray_studio/space65/keymaps/billiams/readme.md Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/gray_studio/space65/keymaps/billiams/readme.md Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/gray_studio/space65/keymaps/billiams/keymap.c Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> * remove unnecessary code from keymap * updated keys and cleaned up readme Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
Diffstat (limited to 'keyboards/gray_studio/space65/keymaps/billiams/readme.md')
-rw-r--r--keyboards/gray_studio/space65/keymaps/billiams/readme.md80
1 files changed, 80 insertions, 0 deletions
diff --git a/keyboards/gray_studio/space65/keymaps/billiams/readme.md b/keyboards/gray_studio/space65/keymaps/billiams/readme.md
new file mode 100644
index 0000000000..bf14fbfe94
--- /dev/null
+++ b/keyboards/gray_studio/space65/keymaps/billiams/readme.md
@@ -0,0 +1,80 @@
+## Billiam's Space65 layout (with split backspace)
+
+This layout is optimized for vim users on MacOS with a split backspace.
+
+Settings:
+
+* The `CAPS LOCK` key is a function key.
+* The `ALT` and `CMD` keys are swapped to replicate the Mac layout.
+* RESET is available as `Fn`+ `Right Ctrl` + `ESC`
+* Underglow toggle is available as `Fn` + `Q`.
+* vim-style arrow key bindings H J K L in layer 1
+
+### Initial Installation
+
+I found the instructions to be longer than they had to be, and I ended up having to Google some steps anyway. These are the steps I took to get my keyboard setup, in case you are new to the process.
+
+1. Fork and Clone the qmk_firmware repo locally
+```
+# Choose one:
+git clone git@github.com:qmk/qmk_firmware.git # OR
+git clone https://github.com/qmk/qmk_firmware.git
+```
+2. Customize your layout by starting with a [keymap](https://github.com/qmk/qmk_firmware/tree/master/keyboards/gray_studio/space65/keymaps). I copied the default and changed it to my liking.
+3. Before plugging in your keyboard into your computer, hold `ESC` key down
+4. Plug the keyboard into your computer, which will put the keyboard in bootloader mode.
+5. Build your hex file and flash your keyboard
+```
+make gray_studio/space65:billiams:flash # be in the qmk_firmware directory to do this
+```
+
+Notes:
+- If you are using QMK Toolbox, use `make gray_studio/space65:<keymap>` in the base qmk_firmware directory instead of step 5 above which will create a hex file `gray_studio_space65_billiams.hex` which you can then choose in the toolbox and hit flash
+- If you accidentally loaded the default keymap, then to `RESET` the keyboard and kick it into bootloader mode again, hold the `ESC` key and plug the board in.
+
+Hope this helps!
+
+### 0 Qwerty
+```
+,------------------------------------------------------------------------------------------------.
+| ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | - | = | \ | Del | INS |
+|------------------------------------------------------------------------------------------------+
+| Tab | Q | W | E | R | T | Y | U | I | O | P | [ | ] | Bkspc | PGUP |
+|------------------------------------------------------------------------------------------------+
+| Fn1 | A | S | D | F | G | H | J | K | L | ; | ' | Enter | PGDN |
+|------------------------------------------------------------------------------------------------+
+| Shift | Z | X | C | V | B | N | M | , | . | ?/ | Shift | up | ESC |
+|------------------------------------------------------------------------------------------------+
+| Ctrl | Alt | Cmd | Space | Alt | Ctrl | Left | Down | Right |
+`------------------------------------------------------------------------------------------------'
+```
+
+### 1 Fn Layer
+```
+,------------------------------------------------------------------------------------------------.
+| | F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | F11 | F12 |Vol- |Vol+ | Next |
+|------------------------------------------------------------------------------------------------+
+| |RGB T|RGB M| Hue-| Hue+| Sat-| Sat+| Val-| Val+| Spd- | Spd+ | | | | Prev |
+|------------------------------------------------------------------------------------------------+
+| | RGBP | RGBG | RGBK | | | Left| Down| Up |Right| | | Play/Pause | |
+|------------------------------------------------------------------------------------------------+
+| | | | | | | | | | Scr- | Scr+ | | |PGUP | |
+|------------------------------------------------------------------------------------------------+
+| | | | | | Fn2 | HOME | PGDN | END |
+`------------------------------------------------------------------------------------------------'
+```
+
+### 2 Fn Layer - Just for bootloader mode button
+```
+,------------------------------------------------------------------------------------------------.
+| | | | | | | | | | | | | | | | |
+|------------------------------------------------------------------------------------------------+
+| | | | | | | | | | | | | | | |
+|------------------------------------------------------------------------------------------------+
+| | | | | | | | | | | | | | |
+|------------------------------------------------------------------------------------------------+
+| | | | | | | | | | | | | | | RESET |
+|------------------------------------------------------------------------------------------------+
+| | | | | | | | | |
+`------------------------------------------------------------------------------------------------'
+```