summaryrefslogtreecommitdiff
path: root/keyboards/bastardkb/tbkmini/readme.md
blob: 74e24ff5069e9ad36c2164b6ce9f07e2e4f28e21 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# TBK Mini

A split, compact ergonomic keyboard.

* Keyboard Maintainer: [Bastard Keyboards](https://github.com/Bastardkb/)
* Hardware Supported: elite-C V4
* Hardware Availability: [Bastardkb.com](https://bastardkb.com/)

## Building the firmware

**You must specify the shield version when compiling/flashing the firmware.**

The template is:

```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`    |

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/)