keychron_qmk_firmware/keyboards/tgr/jane/readme.md
MechMerlin 2367e3e1fd [Keyboard] TGR Jane v2 (#6361)
* initial commit TGR Jane

* lighting support

* use the default keymap lifted from community layouts for LAYOUT_tkl_ansi

* add information regarding reset key, hardware supported, and hardware availability

* document that it supports v1.1 as well thanks to nickheller's confirmation

* update some verbage in the readme

* add QMK Configurator support

* establish switch matrix for three main layouts

* add community layout support

* readme fixes

* Update keyboards/tgr/jane/info.json

Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>

* Update keyboards/tgr/jane/rules.mk

Co-Authored-By: Drashna Jaelre <drashna@live.com>

* Update keyboards/tgr/jane/config.h

Co-Authored-By: fauxpark <fauxpark@gmail.com>
2019-07-26 21:49:29 -07:00

1.8 KiB

Jane v2

TKL Custom Keyboard.

Keyboard Maintainer: MechMerlin
Hardware Supported: TGR Jane (Pontoporia) PCB v1.1, v1.2
Hardware Availability: Geekhack Group Buy

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.
  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 and the make instructions for more information. Brand new to QMK? Start with our Complete Newbs Guide.