keyboards/singa/readme.md

   1 # Singa
   2
   3
   4 ![Singa](https://i.imgur.com/VVO27Tr.jpg)
   5
   6
   7 75% Custom Keyboard.
   8
   9
  10 Keyboard Maintainer: [amnesia0287](https://github.com/amnesia0287)
  11 Hardware Supported: TGR-Elaine v1.0 PCB
  12 Hardware Availability: http://singakbd.com/
  13
  14
  15 Make example for this keyboard (after setting up your build environment):
  16
  17     make singa:default
  18
  19 Flashing
  20
  21 ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods.
  22
  23 **Reset Key:** Hold down the key located at `K00`, commonly programmed as `Esc` while plugging in the keyboard.
  24
  25 Windows:
  26 1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
  27 2. Place your keyboard into reset.
  28 3. Press the `Find Device` button and ensure that your keyboard is found.
  29 4. Press the `Open .hex File` button and locate the `.hex` file you created.
  30 5. Press the `Flash Device` button and wait for the process to complete.
  31
  32 macOS:
  33 1. Install homebrew by typing the following:
  34     ```
  35     /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
  36     ```
  37 2. Install `crosspack-avr`.
  38     ```
  39     brew cask install crosspack-avr
  40     ```
  41 3. Install the following packages:
  42     ```
  43     brew install python3
  44     pip3 install pyusb
  45     brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
  46     ```
  47
  48 4. Place your keyboard into reset.
  49 5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
  50
  51
  52 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).