diff options
| author | Charly Delay <0xcharly@users.noreply.github.com> | 2022-11-15 17:51:44 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-15 08:51:44 +0000 |
| commit | 30b2dbe369b3a61d1d6681b0a689dbcdd41fc221 (patch) | |
| tree | cddf4e7318c2b06d33d4b3750d2e4eb15f1d2333 /keyboards/bastardkb/tbkmini/readme.md | |
| parent | ee7426e7b19c25ddfc53d0b50db68a457d8f992b (diff) | |
Bastard Keyboards: upstream recent changes (#18903)
* bastardkb: cleanup blackpill configuration
Fixes #17
* bastardkb: fix splinky configuration
The pinout of the splinky changed between the last beta batch, and the
production one. This commit updates the keyboard definition to support
the new pinout by default, while offering backward compatibility.
Define `SPLINKY_BETA_PINOUT` to build the firmware with pre-production
pinout.
Fixes #15
* bastardkb: add support for STeMCell
* Update scylla/tbkmini/skeletyl outdated readmes
* bastardkb/dilemma: enable circular scroll
* bastardkb/dilemma: add initial version of the `via` keymap
* bastardkb/dilemma/assembled: add new keyboard
Fixes #20
* bastardkb/dilemma: remove elite-c
* Initial support for the Dilemma 3x5+3 Assembled RGB
* Address code review comments
* Address more comments
* Address review comments
* Address more nits
* bastardkb: split splinky-based keyboards to distinguish between Splinky v2 and v3 pinout
Diffstat (limited to 'keyboards/bastardkb/tbkmini/readme.md')
| -rw-r--r-- | keyboards/bastardkb/tbkmini/readme.md | 20 |
1 files changed, 17 insertions, 3 deletions
diff --git a/keyboards/bastardkb/tbkmini/readme.md b/keyboards/bastardkb/tbkmini/readme.md index 8be8200ff9..74e24ff506 100644 --- a/keyboards/bastardkb/tbkmini/readme.md +++ b/keyboards/bastardkb/tbkmini/readme.md @@ -6,10 +6,24 @@ A split, compact ergonomic keyboard. * 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:default +**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/)
\ No newline at end of file +See the [keyboard build instructions](http://docs.bastardkb.com/) |