qmk_firmware

QMK firmware for my keyboards (Corne, Sweep Ferris) and trackball (Ploopy Adept)
Log | Files | Refs | Submodules | LICENSE

readme.md (1068B)


      1 # Keychron S1
      2 
      3 A customizable 75% keyboard with RGB backlight and White backlight.
      4 
      5 * Keyboard Maintainer: [Keychron](https://github.com/keychron)
      6 * Hardware Supported: Keychron S1
      7 * Hardware Availability: [Keychron](https://www.keychron.com)
      8 
      9 Make example for this keyboard (after setting up your build environment):
     10 
     11 * For RGB backlight version:
     12 
     13 ```bash
     14 make keychron/s1/ansi/rgb:default
     15 ```
     16 
     17 * For White backlight version:
     18 
     19 ```bash
     20 make keychron/s1/ansi/white:default
     21 ```
     22 
     23 Flashing example for this keyboard:
     24 
     25 * For RGB backlight version:
     26 
     27 ```bash
     28 make keychron/s1/ansi/rgb:default:flash
     29 ```
     30 
     31 * For White backlight version:
     32 
     33 ```bash
     34 make keychron/s1/ansi/white:default:flash
     35 ```
     36 
     37 **Reset Key**: Hold down the key located at *K00*, commonly programmed as *Esc* while plugging in the keyboard.
     38 
     39 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).