qmk_firmware

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

readme.md (1316B)


      1 # Compacx
      2 
      3 ![image](https://github.com/takashicompany/compacx/blob/master/images/qmk.jpg?raw=true)
      4 
      5 "Compacx" is a 35-key keyboard with an ISO enter key.
      6 It is the perfect size for a macro pad or a one-handed gaming keyboard.
      7 It can also be used as a split keyboard by combining two units.
      8 
      9 * Keyboard Maintainer: [takashicompany](https://github.com/takashicompany)
     10 * Hardware Supported: PCB, Pro Micro
     11 * Hardware Availability: https://github.com/takashicompany/compacx
     12 
     13 Make example for this keyboard (after setting up your build environment):
     14 
     15     make takashicompany/compacx:default
     16 
     17 Flashing example for this keyboard:
     18 
     19     make takashicompany/compacx:default:flash
     20 
     21 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).
     22 
     23 ## Bootloader
     24 
     25 Enter the bootloader in 3 ways:
     26 
     27 * **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
     28 * **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
     29 * **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available