diff options
Diffstat (limited to 'keyboards/draculad/readme.md')
-rw-r--r-- | keyboards/draculad/readme.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/keyboards/draculad/readme.md b/keyboards/draculad/readme.md new file mode 100644 index 000000000..585d6cb5f --- /dev/null +++ b/keyboards/draculad/readme.md | |||
@@ -0,0 +1,31 @@ | |||
1 | # DracuLad | ||
2 | |||
3 |  | ||
4 | |||
5 | *A 34-36 key split keyboard* | ||
6 | - 36 keys, two of them can be replaced by rotary encoders making it support 34-36 keys and 2-4 encoders. | ||
7 | - bright RGB Underglow with WS2812B LEDs | ||
8 | - one SSD1306 OLED per side | ||
9 | - aggressive pinky stagger similar to the Kyria but with an alternative thumb cluster to raise comfort for large hands | ||
10 | - support for MX and Choc switches | ||
11 | |||
12 | * Keyboard Maintainer: [MangoIV](https://github.com/MangoIV) | ||
13 | * Hardware Supported: [DracuLad PCBs and cases](https://github.com/MangoIV/dracuLad), [the Pimoroni trackball](https://shop.pimoroni.com/products/trackball-breakout) | ||
14 | * Hardware Availability: [MangoIV's GitHub](https://github.com/MangoIV/dracuLad) | ||
15 | |||
16 | Make example for this keyboard (after setting up your build env): | ||
17 | |||
18 | make draculad:default | ||
19 | |||
20 | or for the version using the Pimoroni trackball: | ||
21 | |||
22 | make draculad:pimoroni | ||
23 | |||
24 | Flashing example for DFU and Caterina respectively (replace `default` with the name of your keymap): | ||
25 | |||
26 | make draculad:default:dfu | ||
27 | make draculad:default:flash | ||
28 | |||
29 | When flashing the first time using handedness by EEPROM, use the [QMK guide for that topic](https://docs.qmk.fm/#/feature_split_keyboard?id=handedness-by-eeprom). | ||
30 | |||
31 | 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). | ||