summaryrefslogtreecommitdiffstats
path: root/keyboards/tgr/alice/readme.md
diff options
context:
space:
mode:
authorMechMerlin <30334081+mechmerlin@users.noreply.github.com>2019-08-07 19:02:27 -0700
committerDrashna Jaelre <drashna@live.com>2019-08-07 19:02:27 -0700
commit2c0c25d0140d75e0cd005b10aa5bc35837c363f5 (patch)
tree129de3377360fdf869c5d68555a6bf9b7b743052 /keyboards/tgr/alice/readme.md
parent8479dd65d404ff5e401ea80dfb16160d65247307 (diff)
Move Alice to TGR Directory (#6502)
* git mv alice into the tgr directory * update readme with new build instructions
Diffstat (limited to 'keyboards/tgr/alice/readme.md')
-rw-r--r--keyboards/tgr/alice/readme.md48
1 files changed, 48 insertions, 0 deletions
diff --git a/keyboards/tgr/alice/readme.md b/keyboards/tgr/alice/readme.md
new file mode 100644
index 0000000000..f5db63814b
--- /dev/null
+++ b/keyboards/tgr/alice/readme.md
@@ -0,0 +1,48 @@
+# Alice
+
+![TGR Alice](https://i.imgur.com/cJohEqS.jpg)
+
+An ergonomic 60% keyboard.
+
+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.
+
+
+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).