diff options
Diffstat (limited to 'layouts/community/planck_mit/guidoism/readme.md')
| -rw-r--r-- | layouts/community/planck_mit/guidoism/readme.md | 107 |
1 files changed, 107 insertions, 0 deletions
diff --git a/layouts/community/planck_mit/guidoism/readme.md b/layouts/community/planck_mit/guidoism/readme.md new file mode 100644 index 000000000..540db64e8 --- /dev/null +++ b/layouts/community/planck_mit/guidoism/readme.md | |||
| @@ -0,0 +1,107 @@ | |||
| 1 | # Guido's Planck Keyboard Layout | ||
| 2 | |||
| 3 | I've written a script to convert the json file from the | ||
| 4 | [QMK Configurator](https://config.qmk.fm) to the C macros | ||
| 5 | and a pretty form the comments. | ||
| 6 | |||
| 7 | First import the json file in this directory into the configurator, | ||
| 8 | make any changes, export the file and then run this: | ||
| 9 | |||
| 10 | mv ~/Downloads/guidoism.json layouts/community/ortho_4x12/guidoism/ && python3 layouts/community/ortho_4x12/guidoism/generate_c.py && make planck:guidoism:dfu | ||
| 11 | |||
| 12 | TODO: Move running of generate_c.py to makefile so I just need to run `make planck:guidoism:dfu` | ||
| 13 | |||
| 14 | Note that the pretty forms of the keys are defined in another json | ||
| 15 | file and are made for my specific board. You made need to update this | ||
| 16 | file to get the pretty forms to look right. | ||
| 17 | |||
| 18 | * Left palm to the `mov` key gets you the `Move` layer | ||
| 19 | * Right thumb on the `raise` key gets you the various programming brackets and parens on your left hand | ||
| 20 | * Left palm on `mov` key and left thumb on `lower` key gets you a numpad on your right hand | ||
| 21 | * Shift with the spacebar | ||
| 22 | * Left pinky is control on hold and escape on tap | ||
| 23 | |||
| 24 | ## Current Configuration | ||
| 25 | |||
| 26 | ## Qwerty | ||
| 27 | ``` | ||
| 28 | ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐ | ||
| 29 | │ ⇥ │ q │ w │ e │ r │ t │ y │ u │ i │ o │ p │ ⌫ │ | ||
| 30 | ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤ | ||
| 31 | │ ctrl│ a │ s │ d │ f │ g │ h │ j │ k │ l │ : │ ⏎ │ | ||
| 32 | ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤ | ||
| 33 | │ ⇧ │ z │ x │ c │ v │ b │ n │ m │ , │ . │ / │ │ | ||
| 34 | ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤ | ||
| 35 | │ mov │ ⎋ │ ⌥ │ ⌘ │lower│ sp/sh │raise│ ⌘ │ ⌥ │ ; │ fn │ | ||
| 36 | └─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┘ | ||
| 37 | ``` | ||
| 38 | |||
| 39 | |||
| 40 | ## Lower | ||
| 41 | ``` | ||
| 42 | ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐ | ||
| 43 | │ ~ │ ! │ @ │ # │ $ │ % │ ^ │ & │ * │ │ │ undo│ | ||
| 44 | ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤ | ||
| 45 | │ │ │ cut │ copy│paste│ │ │ _ │ + │ " │ ' │ | │ | ||
| 46 | ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤ | ||
| 47 | │ caps│ │ │ │ │ │ │ │ │ │ │ │ | ||
| 48 | ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤ | ||
| 49 | │ │ │ │ │ │ │ │ next│ vol-│ vol+│ play│ | ||
| 50 | └─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┘ | ||
| 51 | ``` | ||
| 52 | |||
| 53 | |||
| 54 | ## Raise | ||
| 55 | ``` | ||
| 56 | ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐ | ||
| 57 | │ ` │ 1 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 │ 9 │ 0 │ │ | ||
| 58 | ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤ | ||
| 59 | │ │ [ │ ] │ ( │ ) │ │ │ - │ = │ │ │ \ │ | ||
| 60 | ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤ | ||
| 61 | │ │ < │ > │ { │ } │ │ │ │ │ │ │ │ | ||
| 62 | ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤ | ||
| 63 | │ │ │ │ │ │ │ │ │ │ │ │ | ||
| 64 | └─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┘ | ||
| 65 | ``` | ||
| 66 | |||
| 67 | |||
| 68 | ## Movement | ||
| 69 | ``` | ||
| 70 | ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐ | ||
| 71 | │reset│debug│ │ │ │ │ │ pgup│ ↑ │ pgdn│ │ │ | ||
| 72 | ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤ | ||
| 73 | │ │ │ │ │ │ │ │ ← │ ↓ │ → │ │ │ | ||
| 74 | ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤ | ||
| 75 | │ │ │ │ │ │ │ │ home│ │ end │ │ │ | ||
| 76 | ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤ | ||
| 77 | │ │ │ │ │ │ │ │ │ │ │ │ | ||
| 78 | └─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┘ | ||
| 79 | ``` | ||
| 80 | |||
| 81 | |||
| 82 | ## Numpad | ||
| 83 | ``` | ||
| 84 | ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐ | ||
| 85 | │ │ │ │ │ │ │ % │ 7 │ 8 │ 9 │ 0 │ │ | ||
| 86 | ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤ | ||
| 87 | │ │ │ │ │ │ │ $ │ 4 │ 5 │ 6 │ . │ │ | ||
| 88 | ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤ | ||
| 89 | │ │ │ │ │ │ │ 0 │ 1 │ 2 │ 3 │ , │ │ | ||
| 90 | ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤ | ||
| 91 | │ │ │ │ │ │ │ │ 0 │ │ │ │ | ||
| 92 | └─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┘ | ||
| 93 | ``` | ||
| 94 | |||
| 95 | |||
| 96 | ## Function | ||
| 97 | ``` | ||
| 98 | ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐ | ||
| 99 | │ │ f1 │ f2 │ f3 │ f4 │ f5 │ f6 │ f7 │ f8 │ f9 │ f10 │ │ | ||
| 100 | ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤ | ||
| 101 | │ │ │ │ │ │ │ │ │ │ │ │ │ | ||
| 102 | ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤ | ||
| 103 | │ │ │ │ │ │ │ │ │ │ │ │ │ | ||
| 104 | ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤ | ||
| 105 | │ │ │ │ │ │ │ │ │ │ │ │ | ||
| 106 | └─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┘ | ||
| 107 | ``` | ||