diff options
Diffstat (limited to 'keyboards/splitty/readme.md')
-rw-r--r-- | keyboards/splitty/readme.md | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/keyboards/splitty/readme.md b/keyboards/splitty/readme.md new file mode 100644 index 000000000..1dec34c66 --- /dev/null +++ b/keyboards/splitty/readme.md | |||
@@ -0,0 +1,45 @@ | |||
1 | # Splitty | ||
2 | |||
3 |  | ||
4 | |||
5 |  | ||
6 | |||
7 |  | ||
8 | |||
9 |  | ||
10 | |||
11 | This is a split ergonomic keyboard initially based on the Ergodox layout | ||
12 | without the thumb cluster. It uses 32 keys per sides with Cherry MX | ||
13 | compatibles switches, thirty 1u and two vertical 1.5u caps. | ||
14 | |||
15 | The controller is integrated in order to make the keyboard as slim as possible. | ||
16 | |||
17 | It connects to the computer using a micro-B USB. Both sides are connected | ||
18 | together also using micro-B USB. Any connection mistake should not break | ||
19 | anything and the keyboard supports hot plugging. | ||
20 | |||
21 | * Keyboard Maintainer: [Nicolas Schodet](https://github.com/schodet) | ||
22 | * Hardware Supported: Splitty | ||
23 | * Hardware Availability: [Splitty](https://git.ni.fr.eu.org/splitty.git/about/) | ||
24 | |||
25 | Make example for this keyboard (after setting up your build environment): | ||
26 | |||
27 | make splitty:default | ||
28 | |||
29 | Flashing example for this keyboard: | ||
30 | |||
31 | make splitty:default:flash | ||
32 | |||
33 | Handedness should be programmed in EEPROM once, you can use these commands to | ||
34 | flash the firmware and the EEPROM: | ||
35 | |||
36 | make splitty:default:dfu-split-left | ||
37 | make splitty:default:dfu-split-right | ||
38 | |||
39 | If you do not have a reset keycode in your keymap, press the reset button or | ||
40 | short the corresponding contacts if not populated to enter bootloader. | ||
41 | |||
42 | See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) | ||
43 | and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) | ||
44 | for more information. Brand new to QMK? Start with our | ||
45 | [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). | ||