qmk

Unnamed repository; edit this file 'description' to name the repository.
git clone git://git.z3bra.org/qmk.git
Log | Files | Refs | Submodules | LICENSE

readme.md (1930B)


      1 # Pearl 40%
      2 
      3 Pearl 40% is a keyboard designed by Koobaczech. It uses an Atmel
      4 ATMEGA32A MCU.
      5 
      6 Keyboard Maintainer: [Ethan Madden](https://github.com/jetpacktuxedo)  
      7 Hardware Supported: Pearl  
      8 Hardware Availability: [Geekhack Group Buy](https://geekhack.org/index.php?topic=92259.0) 
      9 
     10 Make example for this keyboard (after setting up your build environment):
     11 
     12     make pearl:default
     13 
     14 Flashing
     15 
     16 ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 
     17 
     18 **Reset Key:** Hold down the key located at `K00`.
     19 
     20 Windows: 
     21 1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
     22 2. Place your keyboard into reset. 
     23 3. Press the `Find Device` button and ensure that your keyboard is found.
     24 4. Press the `Open .hex File` button and locate the `.hex` file you created.
     25 5. Press the `Flash Device` button and wait for the process to complete. 
     26 
     27 macOS:
     28 1. Install homebrew by typing the following:   
     29     ```
     30     /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
     31     ```
     32 2. Install `crosspack-avr`.  
     33     ```
     34     brew cask install crosspack-avr
     35     ```
     36 3. Install the following packages:
     37     ```
     38     brew install python3
     39     pip3 install pyusb
     40     brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
     41     ```
     42 4. Place your keyboard into reset. 
     43 5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. 
     44 
     45 **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.
     46 
     47 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).