aboutsummaryrefslogtreecommitdiff
path: root/keyboards/bastardkb/tbk/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/bastardkb/tbk/readme.md')
-rw-r--r--keyboards/bastardkb/tbk/readme.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/keyboards/bastardkb/tbk/readme.md b/keyboards/bastardkb/tbk/readme.md
new file mode 100644
index 000000000..9359e6ad9
--- /dev/null
+++ b/keyboards/bastardkb/tbk/readme.md
@@ -0,0 +1,22 @@
1# The Bastard Keyboard
2
3A split ergonomic keyboard.
4
5* Keyboard Maintainer: [Bastard Keyboards](https://github.com/Bastardkb/)
6* Hardware Supported: elite-C V4
7* Hardware Availability: [Bastard Keyboards](https://bastardkb.com/)
8
9Make example for this keyboard (after setting up your build environment):
10
11 make bastardkb/tbk:default
12
13See 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).
14
15See the [keyboard build instructions](https://docs.bastardkb.com)
16
17
18## Important information regarding the reset
19
20If you modify this firmware, make sure to always have a RESET key that can be triggered using only the master side ! This way you ensure that you can always flash the keyboard, even if you mess up.
21
22Otherwise if you're stuck, open the case and reset manually by shorting Gnd and Rst, or pressing the RST button.