keyboards/unikorn/readme.md

   1 # Unikorn 60
   2
   3 60% PCB made for the TGR x SINGA Unikorn60.
   4
   5
   6 Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
   7 Hardware Supported: Unikorn 60 PCB
   8 Hardware Availability: [Geekhack GB](https://geekhack.org/index.php?topic=98350.0)
   9
  10
  11 Make example for this keyboard (after setting up your build environment):
  12
  13     make unikorn:default
  14
  15 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.
  16
  17 To enable RGB lighting support, install the necessary components and set RGBLIGHT features in `rules.mk` like so:
  18
  19 ```
  20 RGBLIGHT_ENABLE = yes
  21 RGBLIGHT_CUSTOM_DRIVER = yes
  22 ```
  23
  24
  25 Flashing
  26
  27 ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods.
  28
  29 **Reset Key:** Short the two holes labeled `FW_JP` underneath the PCB, beside the Tab key while plugging in the keyboard.
  30
  31 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.
  32
  33 It is recommended to program a `RESET` key in your keymap.
  34
  35 Windows:
  36 1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
  37 2. Place your keyboard into reset.
  38 3. Press the `Find Device` button and ensure that your keyboard is found.
  39 4. Press the `Open .hex File` button and locate the `.hex` file you created.
  40 5. Press the `Flash Device` button and wait for the process to complete.
  41
  42 macOS:
  43 1. Install homebrew by typing the following:
  44     ```
  45     /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
  46     ```
  47 2. Install `crosspack-avr`.
  48     ```
  49     brew cask install crosspack-avr
  50     ```
  51 3. Install the following packages:
  52     ```
  53     brew install python3
  54     pip3 install pyusb
  55     brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
  56
  57 4. Place your keyboard into reset.
  58 5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
  59
  60
  61 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).