qmk_firmware

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

readme.md (1316B)


      1 # TBK Mini
      2 
      3 * Keyboard Maintainer: [Quentin Lebastard](https://github.com/bastardkb)
      4 * Hardware Supported: BastardKB Blackpill or Pro Micro adapter & compatible development boards
      5 * Hardware Availability: [GitHub](https://github.com/Bastardkb/TBK-Mini)
      6 
      7 Make example for this keyboard (after setting up your build environment):
      8 
      9     make bastardkb/tbkmini/blackpill:default
     10     make bastardkb/tbkmini/promicro:default
     11 
     12 Flashing example for this keyboard:
     13 
     14     make bastardkb/tbkmini/blackpill:default:flash
     15     make bastardkb/tbkmini/promicro:default:flash
     16 
     17 Note if using the `promicro` version: If you are using an Elite-C compatible development board, see [here](../readme.md#handedness-pin-on-elite-c-holder) for setting handedness by pin.
     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 and plug in the keyboard
     26 * **Physical reset button**: Briefly press the button on the back of the adapter PCB
     27 * **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available