diff options
Diffstat (limited to 'keyboards/keyboardio/model01/readme.md')
-rw-r--r-- | keyboards/keyboardio/model01/readme.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/keyboards/keyboardio/model01/readme.md b/keyboards/keyboardio/model01/readme.md new file mode 100644 index 000000000..5f55a8812 --- /dev/null +++ b/keyboards/keyboardio/model01/readme.md | |||
@@ -0,0 +1,37 @@ | |||
1 | # Keyboardio Model 01 | ||
2 | |||
3 | A split keyboard. | ||
4 | |||
5 | * Keyboard Maintainer: QMK Community | ||
6 | * Hardware Supported: Keyboardio Model 01 | ||
7 | * Hardware Availability: [Keyboardio](https://shop.keyboard.io) | ||
8 | |||
9 | Make example for this keyboard (after setting up your build environment): | ||
10 | |||
11 | make keyboardio/model01:default | ||
12 | |||
13 | 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. | ||
14 | Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). | ||
15 | |||
16 | ## Programming the Keyboard | ||
17 | |||
18 | To program the keyboard, if you have avrdude installed: | ||
19 | |||
20 | make keyboardio/model01:default:flash | ||
21 | |||
22 | When prompted to reset your keyboard, press the prog key at upper left. If the | ||
23 | keyboard does not reset, you can hold the prog key while plugging it into your | ||
24 | computer. The prog key will light up red in programming mode. | ||
25 | |||
26 | ## Features | ||
27 | |||
28 | This implements the standard keymap, including mousekeys. | ||
29 | |||
30 | It doesn't do cursor warping - QMK does not support absolute mouse positioning. | ||
31 | |||
32 | LED support is limited. Gamma compensation and the high speed batch update | ||
33 | functions supported by the hardware are not implemented. The high current power | ||
34 | switch is also not implemented, so if you try and turn all the LEDs on at full | ||
35 | brightness, something may conk out. | ||
36 | |||
37 | Hotplugging the two halves works but is not extensively tested. | ||