keyboards/pegasushoof/keymaps/citadel/readme.md

   1 # Citadel keymap for pegasushoof
   2
   3 Designed for ISO-DE and similar ISO layouts.
   4
   5 The central idea of this keymap is to avoid unergonomic key combos that force the user to either press
   6 multiple keys with one hand or to use the left hand for right-sided keys. For instance, ISO-DE users
   7 have to press `AltGr`+`7` to type _{_. The keymap allows ergonomic access to the right-sided keys of the
   8 German AltGr-layer by turning `Caps Lock` into a hybrid Fn/AltGr-key. It can easily be adapted for other
   9 ISO layouts.
  10
  11 The _Function_ layer also offers mouse emulation and function/media keys in the F-Row.
  12
  13 `Pause/Break` is used as a safe _close key_: A _single tap_ does nothing, a _double tap_ executes ALT+F4.
  14
  15 Named after the homonymous space station from _Mass Effect_. Made by [Daniel Rose](https://github.com/droseger/).
  16
  17 ## [1] Layers
  18
  19 ### Layer 1 (Default)
  20     .----.   .-------------------. .-------------------. .-------------------. .--------------.
  21     |Esc |   |F1  |F2  |F3  |F4  | |F5  |F6  |F7  |F8  | |F9  |F10 |F11 |F12 | |PrSc|SLck|2Tp:|
  22     |    |   |    |    |    |    | |    |    |    |    | |    |    |    |    | |SyRq|    |A+F4|
  23     '----'   '-------------------' '-------------------' '-------------------' '--------------'
  24     .------------------------------------------------------------------------. .--------------.
  25     |°   |!   |"   |§   |$   |%   |&   |/   |(   |)   |=   |?   |`   |Backspa| |Ins |Home|PgUp|
  26     |^   |1   |2  ²|3  ³|4   |5   |6   |7  {|8  [|9  ]|0  }|ß  \|´   |       | |    |    |    |
  27     |------------------------------------------------------------------------| |--------------|
  28     |Tab   |Q   |W   |E   |R   |T   |Z   |U   |I   |O   |P   |Ü   |*   |  E  | |Del |End |PgDn|
  29     |      |    |    |   €|    |    |    |    |    |    |    |    |+  ~|  n  | |    |    |    |
  30     |------------------------------------------------------------------\  t  | '--------------'
  31     |Fn:    |A   |S   |D   |F   |G   |H   |J   |K   |L   |Ö   |Ä   |'   | e  |
  32     |Layer 2|    |    |    |    |    |    |    |    |    |    |    |#   | r  |
  33     |------------------------------------------------------------------------|      .----.
  34     |Shift|>   |Y   |X   |C   |V   |B   |N   |M   |;   |:   |_   |Shift      |      |Up  |
  35     |     |<  ¦|    |    |    |    |    |    |   µ|,   |.   |-   |           |      |    |
  36     |------------------------------------------------------------------------| .--------------.
  37     |Ctrl |Super|Alt  |                              |AltGr|Alt  |Fn:  |Ctrl | |Left|Down|Righ|
  38     |     |     |     |                              |     |     |Lay 2|     | |    |    |    |
  39     '------------------------------------------------------------------------' '--------------'
  40
  41 ### Layer 2 (Function)
  42     .----.   .-------------------. .-------------------. .-------------------. .--------------.
  43     |Ctl+|   |My  |WWW:|Calc|Medi| |Mus:|Mus:|Mus:|Mus:| |Vol:|Vol:|Vol:|See:| |    |    |Paus|
  44     |A+De|   |Comp|Home|    |Play| |Prev|Next|Paus|Stop| |Mute|Down|Up  |[3] | |    |    |Brea|
  45     '----'   '-------------------' '-------------------' '-------------------' '--------------'
  46     .------------------------------------------------------------------------. .--------------.
  47     |    |    |    |    |    |    |    |    |    |    |    |    |    |       | |    |    |Mou:|
  48     |    |    |    |    |    |    |    |{   |[   |]   |}   |\   |    |       | |    |    |WhUp|
  49     |------------------------------------------------------------------------| |--------------|
  50     |      |    |    |    |    |    |    |    |    |    |    |    |~   |     | |    |    |Mou:|
  51     |      |    |    |    |    |    |    |    |    |    |    |    |    |     | |    |    |WhDn|
  52     |------------------------------------------------------------------\     | '--------------'
  53     |CapsLck|Mou:|Mou:|    |    |    |    |    |    |    |    |    |    |    |
  54     |       |Fast|Slow|    |    |    |    |    |    |    |    |    |    |    |
  55     |------------------------------------------------------------------------|      .----.
  56     |     |    |    |    |    |    |    |    |µ   |    |    |    |           |      |Mou:|
  57     |     |    |    |    |    |    |    |    |    |    |    |    |           |      |Up  |
  58     |------------------------------------------------------------------------| .--------------.
  59     |Mous:|Mous:|     |                              |     |Super|App  |     | |Mou:|Mou:|Mou:|
  60     |Bttn2|Bttn1|     |                              |     |     |     |     | |Left|Down|Righ|
  61     '------------------------------------------------------------------------' '--------------'
  62
  63 Layer 3 exists solely to prevent users from accidentally activating boot mode: `R` is redefined
  64 as `RESET` key [3].
  65
  66 ## [2] How to build and install
  67 1) Prerequisite: install the necessary [build tools](https://docs.qmk.fm/#/getting_started_build_tools)
  68 such as [dfu-programmer](https://github.com/dfu-programmer/dfu-programmer).
  69    - You might need to [add udev rules](https://docs.qmk.fm/#/faq_build?id=can39t-program-on-linux) under Linux.
  70 2) To test if the keymap compiles, simply run `make pegasushoof:citadel`
  71 3) Enter the `qmk_firmware` root directory and run `make pegasushoof:citadel:dfu`
  72 4) Reset controller to _Boot mode_ by pressing the `RESET` key or by using a magnet.
  73
  74 ## [3] How to access Boot mode after install
  75 Press `Fn+F12+R`