diff options
Diffstat (limited to 'keyboards/bastardkb/tbkmini/readme.md')
-rw-r--r-- | keyboards/bastardkb/tbkmini/readme.md | 36 |
1 files changed, 17 insertions, 19 deletions
diff --git a/keyboards/bastardkb/tbkmini/readme.md b/keyboards/bastardkb/tbkmini/readme.md index 74e24ff506..cc3e547ff4 100644 --- a/keyboards/bastardkb/tbkmini/readme.md +++ b/keyboards/bastardkb/tbkmini/readme.md @@ -1,29 +1,27 @@ # TBK Mini -A split, compact ergonomic keyboard. +* Keyboard Maintainer: [Quentin Lebastard](https://github.com/bastardkb) +* Hardware Supported: BastardKB Blackpill or Pro Micro adapter & compatible development boards +* Hardware Availability: [GitHub](https://github.com/Bastardkb/TBK-Mini) -* Keyboard Maintainer: [Bastard Keyboards](https://github.com/Bastardkb/) -* Hardware Supported: elite-C V4 -* Hardware Availability: [Bastardkb.com](https://bastardkb.com/) +Make example for this keyboard (after setting up your build environment): -## Building the firmware + make bastardkb/tbkmini/blackpill:default + make bastardkb/tbkmini/promicro:default -**You must specify the shield version when compiling/flashing the firmware.** +Flashing example for this keyboard: -The template is: + make bastardkb/tbkmini/blackpill:default:flash + make bastardkb/tbkmini/promicro:default:flash -```shell -qmk compile -kb bastardkb/tbkmini/{VERSION}/elitec -km {KEYMAP} -``` - -| Shield Version | default | via | -| --------------- | -------------------------------------------------------------- | ---------------------------------------------------------- | -| v1 (Elite-C) | `qmk compile -kb bastardkb/tbkmini/v1/elitec -km default` | `qmk compile -kb bastardkb/tbkmini/v1/elitec -km via` | -| v2 (Elite-C) | `qmk compile -kb bastardkb/tbkmini/v2/elitec -km default` | `qmk compile -kb bastardkb/tbkmini/v2/elitec -km via` | -| v2 (Splinky v2) | `qmk compile -kb bastardkb/tbkmini/v2/splinky/v2 -km default` | `qmk compile -kb bastardkb/tbkmini/v2/splinky/v2 -km via` | -| v2 (Splinky v3) | `qmk compile -kb bastardkb/tbkmini/v2/splinky/v3 -km default` | `qmk compile -kb bastardkb/tbkmini/v2/splinky/v3 -km via` | -| v2 (STeMCell) | `qmk compile -kb bastardkb/tbkmini/v2/stemcell -km default` | `qmk compile -kb bastardkb/tbkmini/v2/stemcell -km via` | +Note if using the `promicro` version: If you are using an Elite-C compatible development board, see [here](../readme.md#handedness-in-on-elite-c-holder) for setting handedness by pin. 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). -See the [keyboard build instructions](http://docs.bastardkb.com/) +## Bootloader + +Enter the bootloader in 3 ways: + +* **Bootmagic reset**: Hold down the key at (0,0) in the matrix and plug in the keyboard +* **Physical reset button**: Briefly press the button on the back of the adapter PCB +* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available |