users/bbaserdem/README.md

   1 # Overview
   2
   3 I have mostly ortholinear keyboards, which share a lot of functions.
   4 For this purpose, I collected them here.
   5
   6 I have the following keymaps:
   7
   8 * Gherkin (Does not use the user space)
   9 * XD75RE (Uses different keymap)
  10 * Let's Split
  11 * Let's Split It Up
  12 * Planck
  13
  14 # Layout
  15
  16 I use DVORAK with an unorthodox Turkish layout.
  17 If you wanna grab my code, and you used a layout with a persistent base
  18 layer change, change it to layer 0 before proceeding.
  19
  20 # Layers
  21
  22 * **Dvorak**: Base layer,with dvorak layout.
  23 * **Alternative**: Has alternate characters.
  24 * **Game**: Toggled from *Function*, comfortable for gaming use.
  25 * **Numeric**: Has numericals and symbols. Can be locked.
  26 * **Function**: Layer has media and function keys.
  27 * **Mouse**: Manipulates mouse. Can be locked.
  28 * **Music** Allows playing sounds.
  29
  30 # Functionality
  31
  32 * **RGB Backlight**: With layer indication, and ability to change base layer lighting mode.
  33 * **Secrets**: By placing a secrets.h, and not tracking it, passwords can be stored.
  34 * **Mouse**: Mouse emulation, complete with diagonal keys.
  35 * **Turkish**: An AltGr-like overlay that allows some non-common letters, in unicode.
  36
  37 I suggest checking out how I enabled Turkish keys,
  38 how I planned out RGB lighting,
  39 and my mouse implementation;
  40 they might offer some insight into fringe user cases.
  41
  42 # Issues
  43
  44 All features are too big for the 32kB bootloader.
  45 Offenders are audio and rgb lights; it comes down to one or the other.
  46
  47 ~The Proton board, and rev 6 might fix that.~
  48
  49 # Credits
  50
  51 I have previously written my keymap by myself before, but I rewrote it here,