summaryrefslogtreecommitdiff
path: root/keyboards/handwired/meck_tkl/readme.md
diff options
context:
space:
mode:
authorGabriel Kim <68445851+gabrielkim13@users.noreply.github.com>2022-01-09 14:44:33 -0300
committerGitHub <noreply@github.com>2022-01-09 09:44:33 -0800
commit1df390c34f95fb3c4e07518cf51438986ec7c621 (patch)
tree1d4f044f50518a05483fb3548c3c19c556e5966d /keyboards/handwired/meck_tkl/readme.md
parent7b27957adf3b960958e2592ce10e29fe866ee2fc (diff)
[Keyboard] Add Meck TKL handwired (#15533)
* Add meck_tkl * Fix configuration and pin assignment * Rellocate A10 pin, as it is used by the USB DFU bootloader * Add volume and media keys to the function keys layer * Rellocate source files to the handwired keyboards folder and add documentation * Review changes for PR - Improve LAYOUT macro to match the keyboard layout. - Use "kxy" as pin names on the LAYOUT macro. - Remove unused mcuconf.h and halconf.h. - Fix README. * Improve layout macro naming
Diffstat (limited to 'keyboards/handwired/meck_tkl/readme.md')
-rw-r--r--keyboards/handwired/meck_tkl/readme.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/keyboards/handwired/meck_tkl/readme.md b/keyboards/handwired/meck_tkl/readme.md
new file mode 100644
index 0000000000..ec09047dde
--- /dev/null
+++ b/keyboards/handwired/meck_tkl/readme.md
@@ -0,0 +1,37 @@
+# meck_tkl
+
+![meck_tkl](https://i.imgur.com/eIpQTjQ.jpeg)
+
+A standard tenkeyless keyboard, using STM32 Blackpill.
+
+* Keyboard Maintainer: [Gabriel Kim](https://github.com/gabrielkim13)
+* Hardware Supported: Blackpill F401
+* Hardware Availability: [Thingiverse: Mechanical Keyboard - MECH - TKL](https://www.thingiverse.com/thing:4225961)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make handwired/meck_tkl:default
+
+Flashing example for this keyboard:
+
+ make handwired/meck_tkl: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**: Briefly press the button on the back of the PCB - some may have pads you must short instead
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available
+
+## Wiring instructions
+
+- On Blackpill boards, **avoid** using the following pins, since they will cause either USB enumeration or the DFU bootloader to not work correctly:
+ - **USB-related pins:** `PA10`, `PA11`, `PA12`
+ - **BOOT1 pin:** `PB2`
+
+Sample wiring:
+
+![wiring](https://i.imgur.com/jIDmsNy.jpg)