You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

29 lines
1.7 KiB

  1. # TBK Mini
  2. A split, compact ergonomic keyboard.
  3. * Keyboard Maintainer: [Bastard Keyboards](https://github.com/Bastardkb/)
  4. * Hardware Supported: elite-C V4
  5. * Hardware Availability: [Bastardkb.com](https://bastardkb.com/)
  6. ## Building the firmware
  7. **You must specify the shield version when compiling/flashing the firmware.**
  8. The template is:
  9. ```shell
  10. qmk compile -kb bastardkb/tbkmini/{VERSION}/elitec -km {KEYMAP}
  11. ```
  12. | Shield Version | default | via |
  13. | --------------- | -------------------------------------------------------------- | ---------------------------------------------------------- |
  14. | v1 (Elite-C) | `qmk compile -kb bastardkb/tbkmini/v1/elitec -km default` | `qmk compile -kb bastardkb/tbkmini/v1/elitec -km via` |
  15. | v2 (Elite-C) | `qmk compile -kb bastardkb/tbkmini/v2/elitec -km default` | `qmk compile -kb bastardkb/tbkmini/v2/elitec -km via` |
  16. | v2 (Splinky v2) | `qmk compile -kb bastardkb/tbkmini/v2/splinky/v2 -km default` | `qmk compile -kb bastardkb/tbkmini/v2/splinky/v2 -km via` |
  17. | v2 (Splinky v3) | `qmk compile -kb bastardkb/tbkmini/v2/splinky/v3 -km default` | `qmk compile -kb bastardkb/tbkmini/v2/splinky/v3 -km via` |
  18. | v2 (STeMCell) | `qmk compile -kb bastardkb/tbkmini/v2/stemcell -km default` | `qmk compile -kb bastardkb/tbkmini/v2/stemcell -km via` |
  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. See the [keyboard build instructions](http://docs.bastardkb.com/)