summaryrefslogtreecommitdiff
path: root/keyboards/tgr
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/tgr
parentd14573620d3e964730af960aab3c05a5d061796f (diff)
downloadqmk_firmware-6a8c0a6468f4e4ce48a59152418a226d0f027497.tar.gz
qmk_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/tgr')
-rw-r--r--keyboards/tgr/alice/readme.md41
-rw-r--r--keyboards/tgr/jane/readme.md42
2 files changed, 14 insertions, 69 deletions
diff --git a/keyboards/tgr/alice/readme.md b/keyboards/tgr/alice/readme.md
index f5db63814b..a08aaf71ba 100644
--- a/keyboards/tgr/alice/readme.md
+++ b/keyboards/tgr/alice/readme.md
@@ -4,45 +4,18 @@
An ergonomic 60% keyboard.
-Keyboard Maintainer: [Felipe Coury](https://github.com/fcoury)
-Hardware Supported: TGR Alice
-Hardware Availability: Group buy finished
+* Keyboard Maintainer: [Felipe Coury](https://github.com/fcoury)
+* Hardware Supported: TGR Alice
+* Hardware Availability: Group buy finished
Make example for this keyboard (after setting up your build environment):
make tgr/alice: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 `K00`, commonly programmed as `Esc` 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 tgr/alice:default:flash
+
+**Reset Key**: Hold down the key located at *K00*, commonly programmed as *Esc* 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).
diff --git a/keyboards/tgr/jane/readme.md b/keyboards/tgr/jane/readme.md
index 10986cde33..5c5a2d92d3 100644
--- a/keyboards/tgr/jane/readme.md
+++ b/keyboards/tgr/jane/readme.md
@@ -2,46 +2,18 @@
TKL Custom Keyboard.
-Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
-Hardware Supported: TGR Jane (Pontoporia) PCB v1.1, v1.2
-Hardware Availability: [Geekhack Group Buy](https://geekhack.org/index.php?topic=97552.1200)
-
+* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
+* Hardware Supported: TGR Jane (Pontoporia) PCB v1.1, v1.2
+* Hardware Availability: [Geekhack Group Buy](https://geekhack.org/index.php?topic=97552.1200)
Make example for this keyboard (after setting up your build environment):
make tgr/jane: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 `K00`, commonly programmed as `Esc` 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 tgr/jane:default:flash
+**Reset Key**: Hold down the key located at *K00*, commonly programmed as *Esc* 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).