summaryrefslogtreecommitdiff
path: root/keyboards/planck/keymaps/rjhilgefort/readme.md
diff options
context:
space:
mode:
authorRob Hilgefort <rjhilgefort@gmail.com>2021-01-11 00:11:42 -0700
committerGitHub <noreply@github.com>2021-01-10 23:11:42 -0800
commit0728200e28102c78bde5f1608633f461ced48df7 (patch)
treeea95716542857f9a4b81c7739a9b35c003ba2915 /keyboards/planck/keymaps/rjhilgefort/readme.md
parent8e70c4d94356780a51e121e6254e8fa5cbc91147 (diff)
[Keymap] revamped rjhilgefort planck keymap (#11385)
Diffstat (limited to 'keyboards/planck/keymaps/rjhilgefort/readme.md')
-rw-r--r--keyboards/planck/keymaps/rjhilgefort/readme.md127
1 files changed, 82 insertions, 45 deletions
diff --git a/keyboards/planck/keymaps/rjhilgefort/readme.md b/keyboards/planck/keymaps/rjhilgefort/readme.md
index f446a76194..08c0731785 100644
--- a/keyboards/planck/keymaps/rjhilgefort/readme.md
+++ b/keyboards/planck/keymaps/rjhilgefort/readme.md
@@ -1,63 +1,100 @@
# [🐦 @rjhilgefort](https://twitter.com/rjhilgefort) Planck Layout
-A simple and practical layout featuring:
-
-- Hyper Key === CTRL + ALT + GUI
-- Ctrl/Esc key that is CTRL when held and ESC when tapped
-- Symbols layer that focuses on coding
-- Numpad + media layer
+Fairly straight forward Planck layout, but arranges the symbols more toward coding and features a Mac and Linux base layer instead of multiple Alpha layouts.
![Imgur](https://i.imgur.com/elygxAb.jpg)
+## Features
+
+Here's some highlights/features of the layout.
+
+- Ergonomic symbols layer.
+- Media and Numpad layer.
+- Supports Mac and Linux as 1st class citizens giving each a dedicated base layer and a media layer for each that matches media keys for each OS. The Linux default layer focuses on `Ctrl` instead of `Super` and vice versa for Mac. (When you set Linux as your base layer, the Linux media layer is what you shift into. Same for the Mac layer when that's the base)
+
+## Layers
+
+#### Base (Mac)
+
+```
+,-----------------------------------------------------------------------------------------------------------.
+ KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
+|--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
+ CTL_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
+|--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
+ KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT,
+|--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
+ _______, _______, RAISE, ALT_ESC, KC_LGUI, KC_SPC, KC_SPC, LOWER, HYPER, _______, _______, _______
+,-----------------------------------------------------------------------------------------------------------.
+```
+
+#### Base (Linux)
+
+```
+,-----------------------------------------------------------------------------------------------------------.
+ KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
+|--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
+ ALT_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
+|--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
+ KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT,
+|--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
+ _______, _______, RAISE, GUI_ESC, KC_LCTL, KC_SPC, KC_SPC, LOWER, HYPER, _______, _______, _______
+,-----------------------------------------------------------------------------------------------------------.
+```
+
+#### Lower: Symbol Layer
-## Main
```
-,-------------------------------------------------------------------------------------------------------.
-| Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
-|--------|--------|--------|--------|--------|-------|-------|------|--------|--------|--------|--------|
-| Ct/Esc | A | S | D | F | G | H | J | K | L | ; | " |
-|--------|--------|--------|--------|--------|-------|-------|------|--------|--------|--------|--------|
-| Shift | Z | X | C | V | B | N | M | , | . | / | Enter |
-|--------|--------|--------|--------|--------|-------|-------|------|--------|--------|--------|--------|
-| | Ctrl | Raise | Alt | GUI | Space | Lowr | Hyper | | | Raise |
-`-------------------------------------------------------------------------------------------------------'
+,-----------------------------------------------------------------------------------------------------------.
+ _______, KC_BSLS, KC_SLSH, KC_LBRC, KC_RBRC, KC_TILD, KC_PIPE, KC_EQL, KC_PLUS, KC_MINS, KC_UNDS, _______,
+|--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
+ _______, KC_LCBR, KC_RCBR, KC_LPRN, KC_RPRN, KC_GRV, KC_LEFT, KC_DOWN, KC_UP,KC_RIGHT, _______, _______,
+|--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
+ _______, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, _______,
+|--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
+,-----------------------------------------------------------------------------------------------------------.
```
-## Lower
+#### Raise: Media & Numbers
+
```
,-----------------------------------------------------------------------------------------------------------.
-| | \ | / | [ | ] | ~ | | | = | + | - | _ | |
-|-------|--------|--------|--------|--------|--------|--------|--------|--------|---------|--------|--------|
-| | { | } | ( | ) | ` | ← | ↓ | ↑ | → | Alt | |
-|-------|--------|--------|--------|--------|--------|--------|--------|--------|---------|--------|--------|
-| | ! | @ | # | $ | % | ^ | & | * | ( | ) | |
-|-------|--------|--------|--------|--------|--------|--------|--------|--------|---------|--------|--------|
-| | | | | | | | | | | |
-`-----------------------------------------------------------------------------------------------------------'
+ _______, _______, KC_BRID, KC_VOLU, KC_BRIU, _______, _______, KC_7, KC_8, KC_9, KC_ASTR, _______,
+|--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
+ _______, KC_MUTE, KC_MPRV, KC_MPLY, KC_MNXT, _______, _______, KC_4, KC_5, KC_6, KC_PLUS, _______,
+|--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
+ _______, _______, _______, KC_VOLD, _______, _______, _______, KC_1, KC_2, KC_3, KC_BSLS, _______,
+|--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
+ _______, _______, _______, _______, _______, _______, _______, _______, KC_0, KC_DOT, _______, _______
+,-----------------------------------------------------------------------------------------------------------.
```
-## Raise
+#### Adjust
+
```
-,----------------------------------------------------------------------------------------------------------.
-| | | | | | | | 7 | 8 | 9 | | |
-|-------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|
-| | VolMte | Vol - | Vol + | Ply/Pse| | | 4 | 5 | 6 | | |
-|-------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|
-| | Trak ← | Trak → | Scrn - | Scrn + | | | 1 | 2 | 3 | | |
-|-------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|
-| | | | | | | | 0 | . | | |
-`----------------------------------------------------------------------------------------------------------'
+,-----------------------------------------------------------------------------------------------------------.
+ _______, MAC, LINUX, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+|--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
+ _______, _______, _______, _______, _______, _______, KC_HOME, KC_PGDN, KC_PGUP, KC_END, _______, _______,
+|--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+|--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
+,-----------------------------------------------------------------------------------------------------------.
+)
```
-## Adjust (Lower + Raise)
+## Building And Flashing
+
+#### CLI
+
+```
+sudo make planck/rev6:rjhilgefort-dualos:flash
+```
+
+#### Docker
+
```
-,----------------------------------------------------------------------------------------------------------.
-| | Reset | | | | | | | | | | Del |
-|-------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|
-| | | MuMod | AudOn | AudOff | | | Qwerty | | | | |
-|-------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|
-| | Voice- | Voice+ | MusOn | Musoff | MIDIon | MIDIof | TermOn | TermOff| | | |
-|-------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|
-| | | | | | | | | | | |
-`----------------------------------------------------------------------------------------------------------'
+util/docker_build.sh planck/rev6:rjhilgefort-dualos:flash
```