qmk_firmware

QMK firmware for my keyboards (Corne, Sweep Ferris) and trackball (Ploopy Adept)
Log | Files | Refs | Submodules | LICENSE

readme.md (1333B)

      1 # Kintsugi
      2 
      3 ![kintsugi](https://i.imgur.com/HPdmzdCl.jpeg)
      4 
      5 A 65%-ish keyboard with some extra features.
      6 
      7 ## Features
      8 
      9 * Powered by an ATmega32u4 microcontroller (current version needs an Elite-C to work).
     10 * Encoder.
     11 * OLED screen.
     12 * Underglow.
     13 * Hotswap sockets.
     14 
     15 ## General info
     16 
     17 * Keyboard Maintainer: [Arturo Avila](https://github.com/ADPenrose)
     18 * Hardware Supported: Kintsugi v1 PCB
     19 * Hardware Availability: [Arturo Avila](https://github.com/ADPenrose)
     20 
     21 Make example for this keyboard (after setting up your build environment):
     22 
     23     make kintsugi:default
     24 
     25 Flashing example for this keyboard:
     26 
     27     make kintsugi:default:flash
     28 
     29 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).
     30 
     31 ## Bootloader
     32 
     33 Enter the bootloader in 3 ways:
     34 
     35 * **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
     36 * **Physical reset button**: Briefly press the button on the front of the Elite-C microcontroller _**before soldering**_ it to the PCB- some may have pads you must short instead
     37 * **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available