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