keyboards/pearl/keymaps/cijanzen/README.md

   1 # cijanzen's Pearl 40%
   2
   3 ## Layout
   4
   5 The firmware offers five layers:
   6
   7 1. Base layer
   8 2. Numbers and arrows (Fn1)
   9 3. F-row and navigation (Fn2)
  10 4. Media and RGB controls (Fn3)
  11 5. Utils (Fn2+Fn3)
  12
  13 A few specifics worth mentioning:
  14 - Autoshift has been enabled to allow for easier access of shifted keys
  15 - Tab will operate as tab key on tap and fn layer on hold
  16 - Indicator LEDs indicate the current layer
  17
  18
  19 ![cijanzen's Pearl 40% layout](https://raw.githubusercontent.com/christopherjanzen/qmk_firmware/bab090ee24866e6c38892ffc5ffa53813aec3832/keyboards/pearl/keymaps/cijanzen/pearl-cijanzen-keymap.jpg)
  20
  21 Base for this firmware copied from jetpacktuxedo's and rask's QMK firmware
  22
  23 ---
  24
  25 ## Compiling and flashing
  26
  27 To compile and flash the HEX follow the [Pearl 40% instructions](https://gist.github.com/clee/a43f198a70de0e6dae22d7638b41440a).
  28
  29 You might need to check the comments at the bottom of the gist as well.