qmk_firmware

QMK firmware for my keyboards (Corne, Sweep Ferris) and trackball (Ploopy Adept)
Log | Files | Refs | Submodules | LICENSE

readme.md (1361B)


      1 # Unikorn 60
      2 
      3 60% PCB made for the TGR x SINGA Unikorn60. 
      4 
      5 * Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
      6 * Hardware Supported: Unikorn 60 PCB
      7 * Hardware Availability: [Geekhack GB](https://geekhack.org/index.php?topic=98350.0)
      8 
      9 Make example for this keyboard (after setting up your build environment):
     10 
     11     make unikorn:default
     12 
     13 Flashing example for this keyboard:
     14 
     15     make unikorn:default:flash
     16 
     17 **Reset Key**: Short the two holes labeled `FW_JP` underneath the PCB, beside the Tab key while plugging in the keyboard. 
     18 
     19 Do not confuse this with the LED holes of the switch in the `Tab` position. `FW_JP` is not reachable from the top as the plate blocks access to it. 
     20 
     21 See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
     22 
     23 ## RGB Underglow
     24 This PCB can support RGB underglow. There are pads on the bottom of the PCB for the LED controller chip and for 17 RGB underglow LEDs. The Unikorn 60 case does not have acrylic pieces to properly display underglow effects. 
     25 
     26 To enable RGB lighting support, install the necessary components and set RGBLIGHT features in `rules.mk` like so:
     27 
     28 ```makefile
     29 RGBLIGHT_ENABLE = yes
     30 ```