aboutsummaryrefslogtreecommitdiff
path: root/keyboards/kapl/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/kapl/readme.md')
-rw-r--r--keyboards/kapl/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/kapl/readme.md b/keyboards/kapl/readme.md
new file mode 100644
index 000000000..c42a5d894
--- /dev/null
+++ b/keyboards/kapl/readme.md
@@ -0,0 +1,27 @@
1# Kapl Keyboard
2
3![Kapl Keyboard](https://i.imgur.com/XH8APgi.jpg)
4![Kapl PCB](https://i.imgur.com/uir2nQq.jpg)
5
6The Kapl is a split ergonomic keyboard with 70 keys (7x5).
7
8* Keyboard Maintainer: [keyzog](https://github.com/keyzog)
9* Hardware Supported: Kapl PCB / Pro Micro
10* Hardware Availability: Order PCBs with gerber files from the [repository](https://github.com/keyzog/kapl/tree/main/gerbers)
11
12Make example for this keyboard (after setting up your build environment):
13
14 make kapl/rev1:default
15
16Flashing example for this keyboard:
17
18 make kapl/rev1:default:flash
19
20See 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).
21
22## Bootloader
23
24Enter the bootloader in 2 ways:
25
26* **Physical reset button**: Briefly press the reset button on the PCB
27* **Keycode in layout**: Press the key mapped to `RESET` if it is available