qmk_firmware

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

readme.md (1498B)

      1 # The Kudox Full keyboard
      2 
      3 ![Kudox logo](https://raw.githubusercontent.com/kumaokobo/kudox-keyboard/master/img/kudox.png)
      4 
      5 ![Kudox Full image2](https://raw.githubusercontent.com/kumaokobo/kudox-keyboard/master/img/kudox-full-image2.jpg) | ![Kudox Full image1](https://raw.githubusercontent.com/kumaokobo/kudox-keyboard/master/img/kudox-full-image1.jpg)
      6 :----:|:-----:
      7  front | angle
      8 
      9 - Keyboard Maintainer: [Kumao Kobo](https://github.com/kumaokobo)
     10 - Hardware Supported: Kudox Full PCB rev1.0 w/ Pro Micro
     11 - Assembly guide: [Kudox Full/README](https://github.com/kumaokobo/kudox-keyboard/blob/master/kudox-full/README.md)
     12 
     13 ## Bootloader
     14 
     15 Enter the bootloader in 3 ways:
     16 
     17 * **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
     18 * **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
     19 * **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available
     20 
     21 ## Building Firmware
     22 
     23 Make example for this keyboard (after setting up your build environment):
     24 
     25     make kumaokobo/kudox_full/rev1:default
     26 
     27 
     28 Flashing example for this keyboard:
     29 
     30     make kumaokobo/kudox_full/rev1:default:flash
     31 
     32 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).