summaryrefslogtreecommitdiff
path: root/keyboards/gmmk/compact/readme.md
blob: 162110c90898da082314017615dce3af8c3f3056 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# GMMK Compact Mechanical keyboard

Hardware Supported: SN32F268
Revisions
rev1: IS31FL3731    , NOT SUPPORTED, red led color only
rev2: VS12L03A (I2C), SN before SNSS12116xxxxx
rev3: VS12L17A (SPI), SN equal or after SNSS12116xxxxx

Make example for this keyboard (after setting up your build environment):

    to build ANSI keymap:
    make gmmk/compact:default
    make gmmk/compact/rev2:default
    make gmmk/compact/rev3:default
    
    to build ISO keymap:
    make gmmk/compact:iso
    make gmmk/compact/rev2:iso
    make gmmk/compact/rev3:iso

    to build VIA:
    make gmmk/compact/rev2:via
    make gmmk/compact/rev3:via
    
    For VIA + OpenRGB (WIP),
    https://github.com/gloryhzw/qmk_tool/wiki/VIA-OpenRGB-for-GMMK

PS.
1. Compact is not compatible to full and tkl.
2. FULL would work on TKL. Some rgb effects would got offset issues.
3. Rev2 firmware will work on rev3 without rgb. Hang otherwise.

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).