diff options
author | Andrew Kannan <andrew.kannan@gmail.com> | 2023-07-25 13:28:51 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-07-25 11:28:51 -0600 |
commit | 93549c06b92cac66c3075f0fafd5c379f129eb9f (patch) | |
tree | 293c42c5812dfe11a541409371c3b26608bfd6b4 /keyboards/cannonkeys/bastiontkl/readme.md | |
parent | 87c7118b8829f58abb8f5adec2fccddd8bfcbb23 (diff) |
Add BastionTKL PCB to QMK (#21530)
Co-authored-by: jack <0x6a73@protonmail.com>
Co-authored-by: Danny <nooges@users.noreply.github.com>
Diffstat (limited to 'keyboards/cannonkeys/bastiontkl/readme.md')
-rw-r--r-- | keyboards/cannonkeys/bastiontkl/readme.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/keyboards/cannonkeys/bastiontkl/readme.md b/keyboards/cannonkeys/bastiontkl/readme.md new file mode 100644 index 0000000000..c28083f53e --- /dev/null +++ b/keyboards/cannonkeys/bastiontkl/readme.md @@ -0,0 +1,26 @@ +# BastionTKL PCB + +BastionTKL PCB from CannonKeys + +* Keyboard Maintainer: [Andrew Kannan](https://github.com/awkannan) +* Hardware Supported: RP2040 +* Hardware Availability: [CannonKeys](https://cannonkeys.com) + + +Make example for this keyboard (after setting up your build environment): + + make cannonkeys/bastiontkl:default + +Flashing example for this keyboard: + + make cannonkeys/bastiontkl:default:flash + +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). + +## Bootloader + +Enter the bootloader in 3 ways: + +* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard +* **Physical reset button**: Hold the "BOOTMODE" button on the back of the PCB and briefly press the "RESET" button on the back of the PCB +* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available |