diff options
Diffstat (limited to 'keyboards/keychron/s1/readme.md')
-rw-r--r-- | keyboards/keychron/s1/readme.md | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/keyboards/keychron/s1/readme.md b/keyboards/keychron/s1/readme.md new file mode 100644 index 0000000000..ddb616fcea --- /dev/null +++ b/keyboards/keychron/s1/readme.md @@ -0,0 +1,39 @@ +# Keychron S1 + +A customizable 75% keyboard with RGB backlight and White backlight. + +* Keyboard Maintainer: [Keychron](https://github.com/keychron) +* Hardware Supported: Keychron S1 +* Hardware Availability: [Keychron](https://www.keychron.com) + +Make example for this keyboard (after setting up your build environment): + +* For RGB backlight version: + +```bash +make keychron/s1/ansi/rgb:default +``` + +* For White backlight version: + +```bash +make keychron/s1/ansi/white:default +``` + +Flashing example for this keyboard: + +* For RGB backlight version: + +```bash +make keychron/s1/ansi/rgb:default:flash +``` + +* For White backlight version: + +```bash +make keychron/s1/ansi/white:default:flash +``` + +**Reset Key**: Hold down the key located at *K00*, commonly programmed as *Esc* while plugging in the keyboard. + +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). |