diff options
author | Quentin <qlebastard@gmail.com> | 2021-03-01 06:03:55 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-03-01 16:03:55 +1100 |
commit | 7132526dd276ac637757ddff7ab6f57f64ebb84c (patch) | |
tree | 3bf581daae05be0d17414f75e308db50f29c2009 /keyboards/bastardkb/tbk/readme.md | |
parent | f8266a228cacbc31b0455161e0a8bd073feaa9db (diff) | |
download | qmk_firmware-7132526dd276ac637757ddff7ab6f57f64ebb84c.tar.gz qmk_firmware-7132526dd276ac637757ddff7ab6f57f64ebb84c.zip |
Bastardkb added keyboard and renaming (#11887)
Co-authored-by: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'keyboards/bastardkb/tbk/readme.md')
-rw-r--r-- | keyboards/bastardkb/tbk/readme.md | 22 |
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 | |||
3 | A 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 | |||
9 | Make example for this keyboard (after setting up your build environment): | ||
10 | |||
11 | make bastardkb/tbk:default | ||
12 | |||
13 | 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). | ||
14 | |||
15 | See the [keyboard build instructions](https://docs.bastardkb.com) | ||
16 | |||
17 | |||
18 | ## Important information regarding the reset | ||
19 | |||
20 | If 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 | |||
22 | Otherwise if you're stuck, open the case and reset manually by shorting Gnd and Rst, or pressing the RST button. | ||