diff options
Diffstat (limited to 'keyboards/crkbd/keymaps/bermeo/readme.md')
| -rw-r--r-- | keyboards/crkbd/keymaps/bermeo/readme.md | 158 |
1 files changed, 158 insertions, 0 deletions
diff --git a/keyboards/crkbd/keymaps/bermeo/readme.md b/keyboards/crkbd/keymaps/bermeo/readme.md new file mode 100644 index 0000000000..a9b0d4ff09 --- /dev/null +++ b/keyboards/crkbd/keymaps/bermeo/readme.md @@ -0,0 +1,158 @@ +# Bermeo Layout for Corne + +## Features + +### *Corne for neo-latin creatives* + +* Usable with left hand only (Figma, Adobe, Spline, etc) to combo with mouse. +* Delete and enter keys on the left side. +* Z and X on left side with lower layer used to control the monitor's brigtness. +* Arrow keys on left hand (vim logic) +* Accentuations used in Romance (neo-latin) languages like Spanish, Portuguese, French and Italian - ` ~ ^ ' -. + +#### Direct ç and ã keys + +The termination "tion" (eg. action) in portuguese is "ção" (eg. ação). This layout is optimized to use the less keys possible to write words with this termination. + +Compared to the `crkbd:default` layout the difference to output ção would be half of the interations: + +| crkbd:bermeo | <sub>`MO(2)`</sub>, `KC_C`, `KC_A`, <sup>`MO(2)`</sup> | +|:--|:--| +| crkbd:default | `KC_QUOT`, `KC_C`, <sub>`MO(2)`</sub>, <sub>`KC_SFT`</sub>, `KC_GRV`, <sup>`MO(2)`</sup>, <sup>`KC_SFT`</sup>, `KC_A` | + +[ <sub>`hold key`</sub> , <sup>`release key`</sup> ] + +### Modern OLED Support + +* Non-intrusive OLED layer indicator. +* Non-intrusive OLED modifier indicators ⌘ ⇧ ⌥ ⌃. +* Fully animated Luna on left side. + +### Full per-key RGB Matrix support + +With the index of every key mapped in the table below to be used with `rgb_matrix_set_color(index, r, g, b)`;. + +#### Indexes of the keys + +||||||||||||||| +|:--:|:--:|:--:|:--:|:--:|:--:|--|--|:--:|:--:|:--:|:--:|:--:|:--:| +| 24 | 23 | 18 | 17 | 10 | 9 ||| 36 | 37 | 44 | 45 | 50 | 51 | +| 25 | 22 | 19 | 16 | 11 | 8 ||| 35 | 38 | 43 | 46 | 49 | 52 | +| 26 | 21 | 20 | 15 | 12 | 7 ||| 34 | 39 | 42 | 47 | 48 | 53 | +||||| 14 | 13 | 6 | 33 | 40 | 41 ||||| + +Each layer uses the LED `14` as an visual indicator: + +* ⚫️ Default layer +* 🔵 Lower (0) +* 🟠 Raise (1) +* 🟢 Numpad (2) +* ⚪️ Control and Command +* 🟡 Shift + +## Mod-taps + +For convenience, QMK includes some Mod-Tap shortcuts to make common combinations more compact in your keymap: +| Key | Description | +| :-- | --: | +| LCTL_T(kc) | Left Control when held, kc when tapped. | +| LSFT_T(kc) | Left Shift when held, kc when tapped. | +| LALT_T(kc) | Left Alt when held, kc when tapped. | +| ALT(kc) | Left Alt + kc when tapped. | +| LGUI_T(kc) | Left GUI when held, kc when tapped. | +| RSFT_T(kc) | Right Shift when held, kc when tapped. | +| RGUI_T(kc) | Right GUI when held, kc when tapped. | + +## Macros + +|Layer | Name | Description | Keys | +| :--: | --: | -- | --: | +| 🟠 | CEDILLA | Directly outputs ç | ' + c | +| 🟠 | AO | Directly outputs ã | shift + ` + a | +| 🟠 | ASPAS | Outputs ", since diaeresis[^1] are less used than " (for coding and quoting) | shift + ' + space | + +## Layers + +### QWERTY + +||||||||||||||| +|:--|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|--:| +| LCTL_T(F3[^2]) | Q | W | E | R | T ||| Y | U | I | O | P | GRAVE | +| LALT_T(TAB) | A | S | D | F | G ||| H | J | K | L | ; | ↵ | +| LSFT_T(←) | Z | X | C | V | B ||| N | M | , | . | / | RGUI_T(→) | +||||| LGUI_T(↓) | MO(1) | SPACE | ⌫ | MO(2)| RSFT_T( ↑) ||||| + + +### LOWER 🔵 + +||||||||||||||| +|:--|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|--:| +|CTL_T(F5[^3]) | 1 | 2 | 3 | 4 | 5 ||| 6 | 7 | 8 | 9 | 0 | ESCAPE | +|LCTL(LGUI(KC_SPC))[^4] | ← | ↓ | ↑ | → | ↵ ||| [ | ] | \ | ' | : | ↵ | +|ALT(←) | F1[^5] | F2[^6] | C | V | ⌫ ||| - | = | < | > | ? | LALT(→) | +||||| LGUI_T(PAGE_DOWN) | _ | SPACE | LALT(⌫) | TG(3) | RSFT_T(PAGE_UP) ||||| + +### RAISE 🟠 + +||||||||||||||| +|:--|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|--:| +LCTL_T(F4[^7]) | ! | @ | # | $ | % ||| ˆ | & | * | ( | ) | ˜ | +LALT_T(TAB) | Ã[^8] | | | | ||| { | } | | | "[^9] | : | ↵ | +LALT(←) | | | Ç[^10] | | ||| _ | + | < | > | ? | LALT(→) | +||||| LGUI_T(END) | TG(3) | SPACE| DEL| _ | RSFT_T(HOME) ||||| + +### NUMPAD 🟢 + +||||||||||||||| +|:--|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|--:| +| RGB_TOG || | | |||| | 7 | 8 | 9 | * | / | +|| RGB_HUI | RGB_SAI | RGB_VAI | RGB_SPI |||| | 4 | 5 | 6 | - | ↵ | +|| RGB_HUD | RGB_SAD | RGB_VAD | RGB_SPD |||| . | 1 | 2 | 3 | + | | +||||| TG(3)| TG(3) | TG(3) | ⌫ | TG(3) | 0 ||||| + +## Usage + +To compile and flash, from `qmk setup` folder, run: + + make crkbd:bermeo:flash + +## Compiled size + + 28658/28672 (99%, 14 bytes free) + +If more space is needed, start by deactivating Macros and Luna's animations. + +## Credits + +Guilherme Bermêo [(github)](https://git.bermeo.dev) + +### Thanks + +* @armand1m +* @brneor +* @drashna +* @hellsingcoder +* @soundmonster +* @wdtamagi + +[^1]: The diaeresis (/daɪˈɛrəsɪs, -ˈɪər-/ dy-ERR-ə-sis, -EER-; also known as the trema) and the umlaut (/ˈʊmlaʊt/) are two different diacritical marks that (in modern usage) look alike. They both consist of two dots ¨ placed over a letter, usually a vowel; when that letter is an i or a j, the diacritic replaces the tittle: ï. In computer systems, both forms have the same code point (binary code). Their appearance in print or on screen may vary between typefaces but rarely within the same typeface. The "diaeresis" diacritic is used to mark the separation of two distinct vowels in adjacent syllables when an instance of diaeresis (or hiatus) occurs, so as to distinguish from a digraph or diphthong. +The "umlaut" diacritic, in contrast, indicates a sound shift phenomenon – also known as umlaut – in which a back vowel becomes a front vowel. +Neither of these phenomena occur in English, except in loanwords (like naïve) or for stylistic reasons (as in the Brontë family or Mötley Crüe). + +[^2]: Open Mission Control. + +[^3]: Bring up the screenshot toolbar. + +[^4]: Opens emoji dialog box. + +[^5]: Decrease display brightness. + +[^6]: Increase display brightness. + +[^7]: Launchpad. + +[^8]: Macro "CEDILLA". + +[^9]: Macro "AO". + +[^10]: Macro "ASPAS". |