keychron_qmk_firmware/keyboards/keyboardio/model01/readme.md
James Young fced377ac0
2020 May 30 Breaking Changes Update (#9215)
* Branch point for 2020 May 30 Breaking Change

* Migrate `ACTION_LAYER_TOGGLE` to `TG()` (#8954)

* Migrate `ACTION_MODS_ONESHOT` to `OSM()` (#8957)

* Migrate `ACTION_DEFAULT_LAYER_SET` to `DF()` (#8958)

* Migrate `ACTION_LAYER_MODS` to `LM()` (#8959)

* Migrate `ACTION_MODS_TAP_KEY` to `MT()` (#8968)

* Convert V-USB usbdrv to a submodule (#8321)

* Unify Tap Hold functions and documentation (#8348)

* Changing board names to prevent confusion (#8412)

* Move the Keyboardio Model01 to a keyboardio/ subdir (#8499)

* Move spaceman keyboards (#8830)

* Migrate miscellaneous `fn_actions` entries (#8977)

* Migrate `ACTION_MODS_KEY` to chained mod keycodes (#8979)

* Organizing my keyboards (plaid, tartan, ergoinu) (#8537)

* Refactor Lily58 to use split_common (#6260)

* Refactor zinc to use split_common (#7114)

* Add a message if bin/qmk doesn't work (#9000)

* Fix conflicting types for 'tfp_printf' (#8269)

* Fixed RGB_DISABLE_AFTER_TIMEOUT to be seconds based & small internals cleanup (#6480)

* Refactor and updates to TKC1800 code (#8472)

* Switch to qmk forks for everything (#9019)

* audio refactor: replace deprecated PLAY_NOTE_ARRAY (#8484)

* Audio enable corrections (2/3) (#8903)

* Split HHKB to ANSI and JP layouts and Add VIA support for each (#8582)

* Audio enable corrections (Part 4) (#8974)

* Fix typo from PR7114 (#9171)

* Augment future branch Changelogs (#8978)

* Revert "Branch point for 2020 May 30 Breaking Change"
2020-05-30 13:14:59 -07:00

38 lines
1.4 KiB
Markdown

# Keyboardio Model 01
A split keyboard.
* Keyboard Maintainer: QMK Community
* Hardware Supported: Keyboardio Model 01
* Hardware Availability: [Keyboardio](https://shop.keyboard.io)
Make example for this keyboard (after setting up your build environment):
make keyboardio/model01:default
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).
## Programming the Keyboard
To program the keyboard, if you have avrdude installed:
make keyboardio/model01:default:flash
When prompted to reset your keyboard, press the prog key at upper left. If the
keyboard does not reset, you can hold the prog key while plugging it into your
computer. The prog key will light up red in programming mode.
## Features
This implements the standard keymap, including mousekeys.
It doesn't do cursor warping - QMK does not support absolute mouse positioning.
LED support is limited. Gamma compensation and the high speed batch update
functions supported by the hardware are not implemented. The high current power
switch is also not implemented, so if you try and turn all the LEDs on at full
brightness, something may conk out.
Hotplugging the two halves works but is not extensively tested.