aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/skog/README.md
diff options
context:
space:
mode:
authorGravatar Jumail Mundekkat <mundekkat@hotmail.com>2018-12-28 03:40:33 +1100
committerGravatar MechMerlin <30334081+mechmerlin@users.noreply.github.com>2018-12-27 08:40:33 -0800
commit3744a2b641628c8e1646ce743c07934314357c51 (patch)
tree1a66255311edbb222948117242d8ec177c90af2f /keyboards/skog/README.md
parentcfba2165413796da0e657675c67e40a8683e6107 (diff)
downloadqmk_firmware-3744a2b641628c8e1646ce743c07934314357c51.tar.gz
Added Skog TKL support (#4727)
* Added Skog TKL support * Updated manufacturer/product name
Diffstat (limited to 'keyboards/skog/README.md')
-rw-r--r--keyboards/skog/README.md61
1 files changed, 61 insertions, 0 deletions
diff --git a/keyboards/skog/README.md b/keyboards/skog/README.md
new file mode 100644
index 000000000..51a792b6b
--- /dev/null
+++ b/keyboards/skog/README.md
@@ -0,0 +1,61 @@
+Skog TKL by Percent
+==========================
+
+Keyboard Maintainer: QMK Community
+Hardware Supported: Skog PCB
+Hardware Availability: https://geekhack.org/index.php?topic=87953.0
+
+Make example for this keyboard (after setting up your build environment):
+
+ make skog:default
+
+## Setting the board to bootloader mode
+
+If you're lucky, the programming script does this automagically for you. If
+however this doesn't work for you, you need to enter the bootloader mode manually
+by plugging the keyboard in while holding the bootloader key. If you did this
+correctly the LEDs will blink and you'll be able to flash your firmware.
+
+The bootloader key is in the top-right (Pause).
+
+## Flashing
+
+ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods.
+
+Windows:
+1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
+2. Place your keyboard into reset.
+3. Press the `Find Device` button and ensure that your keyboard is found.
+4. Press the `Open .hex File` button and locate the `.hex` file you created.
+5. Press the `Flash Device` button and wait for the process to complete.
+
+macOS:
+1. Install homebrew by typing the following:
+ ```
+ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+ ```
+2. Install `crosspack-avr`.
+ ```
+ brew cask install crosspack-avr
+ ```
+3. Install the following packages:
+ ```
+ brew install python
+ brew install pyusb
+ brew install --HEAD`https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
+
+4. Place your keyboard into reset.
+5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
+
+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).
+
+## Troubleshooting
+
+From my experience, it's really hard to brick these boards. But these
+tricks have been useful when it got stuck in a weird scenario.
+
+1. Try plugging the board in while holding the bootloader key. This will force
+ it to boot only the bootloader without loading the firmware. Once this is
+ done, just reflash the board with the original firmware.
+2. Sometimes USB hubs can act weird, so try connecting the board directly
+ to your computer or plugging/unplugging the USB hub.