diff options
Diffstat (limited to 'keyboards/percent/skog/README.md')
| -rw-r--r-- | keyboards/percent/skog/README.md | 42 |
1 files changed, 7 insertions, 35 deletions
diff --git a/keyboards/percent/skog/README.md b/keyboards/percent/skog/README.md index 5b7dacd91..9f76110cd 100644 --- a/keyboards/percent/skog/README.md +++ b/keyboards/percent/skog/README.md | |||
| @@ -1,45 +1,17 @@ | |||
| 1 | # Skog TKL | 1 | # Skog TKL |
| 2 | 2 | ||
| 3 | Keyboard Maintainer: QMK Community | 3 | * Keyboard Maintainer: QMK Community |
| 4 | Hardware Supported: Skog PCB | 4 | * Hardware Supported: Skog PCB |
| 5 | Hardware Availability: https://geekhack.org/index.php?topic=87953.0 | 5 | * Hardware Availability: <https://geekhack.org/index.php?topic=87953.0> |
| 6 | 6 | ||
| 7 | Make example for this keyboard (after setting up your build environment): | 7 | Make example for this keyboard (after setting up your build environment): |
| 8 | 8 | ||
| 9 | make percent/skog:default | 9 | make percent/skog:default |
| 10 | 10 | ||
| 11 | Flashing | 11 | Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) |
| 12 | 12 | ||
| 13 | ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. | 13 | make percent/skog:default:flash |
| 14 | 14 | ||
| 15 | **Reset Key:** Hold down the key located at `K00`, commonly programmed as Pause while plugging in the keyboard. | 15 | **Reset Key**: Hold down the key located at *K00*, commonly programmed as *Pause* while plugging in the keyboard. |
| 16 | 16 | ||
| 17 | Windows: | 17 | 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). |
| 18 | 1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash). | ||
| 19 | 2. Place your keyboard into reset. | ||
| 20 | 3. Press the `Find Device` button and ensure that your keyboard is found. | ||
| 21 | 4. Press the `Open .hex File` button and locate the `.hex` file you created. | ||
| 22 | 5. Press the `Flash Device` button and wait for the process to complete. | ||
| 23 | |||
| 24 | macOS: | ||
| 25 | 1. Install homebrew by typing the following: | ||
| 26 | ``` | ||
| 27 | /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" | ||
| 28 | ``` | ||
| 29 | 2. Install `crosspack-avr`. | ||
| 30 | ``` | ||
| 31 | brew cask install crosspack-avr | ||
| 32 | ``` | ||
| 33 | 3. Install the following packages: | ||
| 34 | ``` | ||
| 35 | brew install python3 | ||
| 36 | pip3 install pyusb | ||
| 37 | brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb | ||
| 38 | ``` | ||
| 39 | |||
| 40 | 4. Place your keyboard into reset. | ||
| 41 | 5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. | ||
| 42 | |||
| 43 | **Please Note:** You will need to use the `EEP_RST` keycode first, followed by unplugging/replugging the board to get RGB underglow effects to work. | ||
| 44 | |||
| 45 | 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). \ No newline at end of file | ||