Changes related to pr checklist

This commit is contained in:
wholteza 2025-07-20 12:49:43 +02:00
parent 2383596553
commit 6e931dc85d
3 changed files with 58 additions and 52 deletions

View File

@ -1,10 +1,8 @@
{ {
"manufacturer": "OLKB",
"keyboard_name": "Planck", "keyboard_name": "Planck",
"maintainer": "Wholteza <zackarias@montell.se>", "maintainer": "Wholteza <zackarias@montell.se>",
"manufacturer": "OLKB",
"url": "https://blog.roastpotatoes.co/guide/2015/11/04/how-to-handwire-a-planck/",
"bootloader": "halfkay", "bootloader": "halfkay",
"processor": "atmega32u4",
"diode_direction": "COL2ROW", "diode_direction": "COL2ROW",
"features": { "features": {
"bootmagic": true, "bootmagic": true,
@ -16,9 +14,11 @@
"cols": ["C7", "D6", "D7", "B4", "B5", "B6", "F7", "F6", "F5", "F4", "F1", "F0"], "cols": ["C7", "D6", "D7", "B4", "B5", "B6", "F7", "F6", "F5", "F4", "F1", "F0"],
"rows": ["E6", "B3", "B7", "D0"] "rows": ["E6", "B3", "B7", "D0"]
}, },
"processor": "atmega32u4",
"url": "https://blog.roastpotatoes.co/guide/2015/11/04/how-to-handwire-a-planck/",
"usb": { "usb": {
"device_version": "1.0.0", "device_version": "1.0.0",
"pid": "0x1234", "pid": "0x0053",
"vid": "0xFEED" "vid": "0xFEED"
}, },
"layouts": { "layouts": {
@ -70,7 +70,7 @@
{"matrix": [3, 8], "x": 8, "y": 3}, {"matrix": [3, 8], "x": 8, "y": 3},
{"matrix": [3, 9], "x": 9, "y": 3}, {"matrix": [3, 9], "x": 9, "y": 3},
{"matrix": [3, 10], "x": 10, "y": 3}, {"matrix": [3, 10], "x": 10, "y": 3},
{"matrix": [3, 11], "x": 11, "y": 3}, {"matrix": [3, 11], "x": 11, "y": 3}
] ]
} }
} }

View File

@ -1,4 +1,4 @@
/* Copyright 2025 Zackarias Montell @Wholteza /* Copyright 2025 Zackarias Montel (@Wholteza)
* *
* This program is free software: you can redistribute it and/or modify * This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by * it under the terms of the GNU General Public License as published by

View File

@ -2,20 +2,26 @@
![plank handwired](https://i.imgur.com/khseWs7.jpeg) ![plank handwired](https://i.imgur.com/khseWs7.jpeg)
A compact 40% (12x4) ortholinear keyboard kit sold by OLKB before they developed the rev1 PCB. A compact 40% (12x4) ortholinear keyboard kit sold by OLKB before the PCB was released.
Keyboard Maintainer: [Wholteza](https://github.com/wholteza) Keyboard Maintainer: [Wholteza](https://github.com/wholteza)
Hardware Supported: [Teensy 2.0](https://www.pjrc.com/store/teensy.html) Hardware Supported: [Teensy 2.0](https://www.pjrc.com/store/teensy.html)
Hardware Availability: [PJRC](https://www.pjrc.com/store/teensy.html)
## Compile and Flash
Make example for this keyboard (after setting up your build environment): Make example for this keyboard (after setting up your build environment):
qmk compile --keyboard handwired/planck --keymap default make handwired/planck:default
To flash the keyaboard, use the Teensy Loader application provided by [PJRC](https://www.pjrc.com/teensy/loader.html). Flashing example for this keyboard:
## Pinout make handwired/planck:default:flash
The pinout can be found in the `keyboard.json` and looking at your keyboards wiring (flipped with the keycaps facing down) column and row 0 is **top left**. 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 (top right) and plug in the keyboard
* **Physical reset button**: Briefly press the button on the front of the PCB.
* **Keycode in layout**: Press the key mapped to `QK_BOOT`. With the default keymap press these keys in order: "lower" + "raise" + "escape".