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