qmk_firmware

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

readme.md (1121B)

      1 # %KEYBOARD%
      2 
      3 ![%KEYBOARD%](imgur.com image replace me!)
      4 
      5 *A short description of the keyboard/project*
      6 
      7 * Keyboard Maintainer: [%REAL_NAME%](https://github.com/%USER_NAME%)
      8 * Hardware Supported: *The PCBs, controllers supported*
      9 * Hardware Availability: *Links to where you can find this hardware*
     10 
     11 Make example for this keyboard (after setting up your build environment):
     12 
     13     make %KEYBOARD%:default
     14 
     15 Flashing example for this keyboard:
     16 
     17     make %KEYBOARD%:default:flash
     18 
     19 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).
     20 
     21 ## Bootloader
     22 
     23 Enter the bootloader in 3 ways:
     24 
     25 * **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
     26 * **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
     27 * **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available