aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/percent
diff options
context:
space:
mode:
authorJoel Challis <git@zvecr.com>2019-11-24 04:42:20 +0000
committerJames Young <18669334+noroadsleft@users.noreply.github.com>2019-11-23 20:42:20 -0800
commit6a8c0a6468f4e4ce48a59152418a226d0f027497 (patch)
tree4937e648fb7d9afdf89fc6c4c92444ac90153fee /keyboards/percent
parentd14573620d3e964730af960aab3c05a5d061796f (diff)
downloadfirmware-6a8c0a6468f4e4ce48a59152418a226d0f027497.tar.gz
firmware-6a8c0a6468f4e4ce48a59152418a226d0f027497.tar.bz2
firmware-6a8c0a6468f4e4ce48a59152418a226d0f027497.zip
[Keyboard] Update ATmega32A readme files to match template (#7462)
* Update atmega32a readme files to match template * Update atmega32a readme files to match template - fixes * Apply suggestions from code review
Diffstat (limited to 'keyboards/percent')
-rw-r--r--keyboards/percent/canoe/readme.md37
-rw-r--r--keyboards/percent/skog/README.md42
-rw-r--r--keyboards/percent/skog_lite/readme.md43
3 files changed, 19 insertions, 103 deletions
diff --git a/keyboards/percent/canoe/readme.md b/keyboards/percent/canoe/readme.md
index 45773e468..d8a496f26 100644
--- a/keyboards/percent/canoe/readme.md
+++ b/keyboards/percent/canoe/readme.md
@@ -2,43 +2,16 @@
A 65% keyboard with some RGB
-Keyboard Maintainer: QMK Community
-Hardware Supported: Canoe
-Hardware Availability: https://geekhack.org/index.php?topic=92418.0
+* Keyboard Maintainer: QMK Community
+* Hardware Supported: Canoe
+* Hardware Availability: <https://geekhack.org/index.php?topic=92418.0>
Make example for this keyboard (after setting up your build environment):
make percent/canoe:default
-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 python3
- pip3 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.
+Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
+ make percent/canoe:default:flash
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).
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 @@
# Skog TKL
-Keyboard Maintainer: QMK Community
-Hardware Supported: Skog PCB
-Hardware Availability: https://geekhack.org/index.php?topic=87953.0
+* 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 percent/skog:default
-Flashing
+Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
-ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods.
+ make percent/skog:default:flash
-**Reset Key:** Hold down the key located at `K00`, commonly programmed as Pause while plugging in the keyboard.
+**Reset Key**: Hold down the key located at *K00*, commonly programmed as *Pause* while plugging in the keyboard.
-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 python3
- pip3 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.
-
-**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.
-
-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
+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).
diff --git a/keyboards/percent/skog_lite/readme.md b/keyboards/percent/skog_lite/readme.md
index 369129e86..72ca79725 100644
--- a/keyboards/percent/skog_lite/readme.md
+++ b/keyboards/percent/skog_lite/readme.md
@@ -2,47 +2,18 @@
TKL Custom Keyboard.
-
-Keyboard Maintainer: [mechmerlin](https://github.com/mechmerlin)
-Hardware Supported: Skog Lite PCB
-Hardware Availability: [Kono Store](https://kono.store/products/skog-lite)
-
+* Keyboard Maintainer: [mechmerlin](https://github.com/mechmerlin)
+* Hardware Supported: Skog Lite PCB
+* Hardware Availability: [Kono Store](https://kono.store/products/skog-lite)
Make example for this keyboard (after setting up your build environment):
make percent/skog_lite:default
-Flashing
-
-ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods.
-
-**Reset Key:** Hold down the key located at `K05`, commonly programmed as `F5` while plugging in the keyboard.
-
-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 python3
- pip3 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.
+Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
+
+ make percent/skog_lite:default:flash
+**Reset Key**: Hold down the key located at *K05*, commonly programmed as *F5* while plugging in the keyboard.
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).