keyboards/skog/README.md

   1 Skog TKL by Percent
   2 ==========================
   3
   4 Keyboard Maintainer: QMK Community
   5 Hardware Supported: Skog PCB
   6 Hardware Availability: https://geekhack.org/index.php?topic=87953.0
   7
   8 Make example for this keyboard (after setting up your build environment):
   9
  10     make skog:default
  11
  12 ## Setting the board to bootloader mode
  13
  14 If you're lucky, the programming script does this automagically for you. If
  15 however this doesn't work for you, you need to enter the bootloader mode manually
  16 by plugging the keyboard in while holding the bootloader key. If you did this
  17 correctly the LEDs will blink and you'll be able to flash your firmware.
  18
  19 The bootloader key is in the top-right (Pause).
  20
  21 ## Flashing
  22
  23 ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods.
  24
  25 Windows:
  26 1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
  27 2. Place your keyboard into reset.
  28 3. Press the `Find Device` button and ensure that your keyboard is found.
  29 4. Press the `Open .hex File` button and locate the `.hex` file you created.
  30 5. Press the `Flash Device` button and wait for the process to complete.
  31
  32 macOS:
  33 1. Install homebrew by typing the following:
  34     ```
  35     /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
  36     ```
  37 2. Install `crosspack-avr`.
  38     ```
  39     brew cask install crosspack-avr
  40     ```
  41 3. Install the following packages:
  42     ```
  43     brew install python
  44     brew install pyusb
  45     brew install --HEAD`https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
  46
  47 4. Place your keyboard into reset.
  48 5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
  49
  50 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).
  51
  52 ## Troubleshooting
  53
  54 From my experience, it's really hard to brick these boards. But these
  55 tricks have been useful when it got stuck in a weird scenario.
  56
  57 1. Try plugging the board in while holding the bootloader key. This will force
  58    it to boot only the bootloader without loading the firmware. Once this is
  59    done, just reflash the board with the original firmware.
  60 2. Sometimes USB hubs can act weird, so try connecting the board directly
  61    to your computer or plugging/unplugging the USB hub.