summaryrefslogtreecommitdiff
path: root/keyboards/rgbkb/zygomorph/keymaps/default/readme.md
blob: e1d30b36b6a1bafd6894641727c87fd17b7f5875 (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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# The Default Zygomorph Layout
## Layout

### Base modifier layout
```
   * ,-----------------------------------------.  ,-----------------------------------------.
   * | GESC |      |      |      |      |      |  |      |      |      |      |      | BkSp |
   * |------+------+------+------+------+------|  |------+------+------+------+------+------|
   * | Tab  |      |      |      |      |      |  |      |      |      |      |      |   \  |
   * |------+------+------+------+------+------|  |------+------+------+------+------+------|
   * |FN(CAPS)|    |      |      |      |      |  |      |      |      |      |      |   '  |
   * |------+------+------+------+------+------|  |------+------+------+------+------+------|
   * |Shift |      |      |      |      |      |  |      |      |      |      |      |Shift |
   * |------+------+------+------+------+------|  |------+------+------+------+------+------|
   * | Ctrl |  Win |  Alt |  RGB | ADJ  | Space|  | Space|  FN  | Left | Down | Up   |Right |
   * `-----------------------------------------'  `-----------------------------------------'
```

### Qwerty alphas
```
     * ,-----------------------------------------.  ,-----------------------------------------.
     * |      |      |      |      |      |      |  |      |      |      |      |      |      |
     * |------+------+------+------+------+------|  |------+------+------+------+------+------|
     * |      |   Q  |   W  |   E  |   R  |   T  |  |   Y  |   U  |   I  |   O  |   P  |      |
     * |------+------+------+------+------+------|  |------+------+------+------+------+------|
     * |      |   A  |   S  |   D  |   F  |   G  |  |   H  |   J  |   K  |   L  |   ;  |      |
     * |------+------+------+------+------+------|  |------+------+------+------+------+------|
     * |      |   Z  |   X  |   C  |   V  |   B  |  |   N  |   M  |   ,  |   .  |   /  |      |
     * |------+------+------+------+------+------|  |------+------+------+------+------+------|
     * |      |      |      |      |      |      |  |      |      |      |      |      |      |
     * `-----------------------------------------'  `-----------------------------------------'
```

### Colemak alphas
```
     * ,-----------------------------------------.  ,-----------------------------------------.
     * |      |      |      |      |      |      |  |      |      |      |      |      |      |
     * |------+------+------+------+------+------|  |------+------+------+------+------+------|
     * |      |   Q  |   W  |   F  |   P  |   G  |  |   J  |   L  |   U  |   Y  |   ;  |      |
     * |------+------+------+------+------+------|  |------+------+------+------+------+------|
     * |      |   A  |   R  |   S  |   T  |   D  |  |   H  |   N  |   E  |   I  |   O  |      |
     * |------+------+------+------+------+------|  |------+------+------+------+------+------|
     * |      |   Z  |   X  |   C  |   V  |   B  |  |   K  |   M  |   ,  |   .  |   /  |      |
     * |------+------+------+------+------+------|  |------+------+------+------+------+------|
     * |      |      |      |      |      |      |  |      |      |      |      |      |      |
     * `-----------------------------------------'  `-----------------------------------------'
```

### Function (FN)
```
     * ,-----------------------------------------.  ,-----------------------------------------.
     * |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |  |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |
     * |------+------+------+------+------+------|  |------+------+------+------+------+------|
     * |      | PGDN |  UP  | PGUP |      |      |  |      | PGDN |  UP  | PGUP | PRINT| HOME |
     * |------+------+------+------+------+------|  |------+------+------+------+------+------|
     * |      | LEFT | DOWN | RIGHT|      |      |  |      | LEFT | DOWN | RIGHT|INSERT| END  |
     * |------+------+------+------+------+------|  |------+------+------+------+------+------|
     * |      |      |      |      |      |      |  |      |      |      |      |      |      |
     * |------+------+------+------+------+------|  |------+------+------+------+------+------|
     * |      |      |      |RGBMOD|      |      |  |      | PLAY | NEXT | MUTE | VOL- | VOL+ |
     * `-----------------------------------------'  `-----------------------------------------'
```

### Adjust (ADJ)
```
     * ,-----------------------------------------.  ,-----------------------------------------.
     * |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |  |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |
     * |------+------+------+------+------+------|  |------+------+------+------+------+------|
     * |      | SAD  | VAI  | SAI  | RESET|      |  |      |      |      |      |      |      |
     * |------+------+------+------+------+------|  |------+------+------+------+------+------|
     * |      | HUD  | VAD  | HUI  |RGBRST|      |  |      |QWERTY|COLEMK|      |      |      |
     * |------+------+------+------+------+------|  |------+------+------+------+------+------|
     * |      |      |      |      |      |      |  |      |      |RGBTOG|  HUI |  SAI | VAI  |
     * |------+------+------+------+------+------|  |------+------+------+------+------+------|
     * |      |      |      |RGBMOD|      |      |  |      |      |RGBRMOD| HUD |  SAD | VAD  |
     * `-----------------------------------------'  `-----------------------------------------'
```

## Customize

see `qmk_firmware/keyboards/zygomorph/rev1/keymaps/default/rules.mk`

```

# Variables you can set for Zygomorph

BOOTMAGIC_ENABLE = no       # Virtual DIP switch configuration(+1000)
MOUSEKEY_ENABLE = no        # Mouse keys(+4700)
EXTRAKEY_ENABLE = yes       # Audio control and System control(+450)
CONSOLE_ENABLE = yes        # Console for debug(+400)
COMMAND_ENABLE = no         # Commands for debug and configuration
NKRO_ENABLE = no            # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
RGBLIGHT_ENABLE = yes       # Enable global lighting effects. Do not enable with RGB Matrix
RGBLIGHT_ANIMATIONS = yes   # LED animations
RGB_MATRIX_ENABLE = no      # Enable per-key coordinate based RGB effects. Do not enable with RGBlight (+8500)
RGB_MATRIX_KEYPRESSES = no  # Enable reactive per-key effects. Can be very laggy (+1500)
RGBLIGHT_FULL_POWER = yes   # Allow maximum RGB brightness. Otherwise, limited to a safe level for a normal USB-A port
UNICODE_ENABLE = no         # Unicode
SWAP_HANDS_ENABLE = no      # Enable one-hand typing
ENCODER_ENABLE = yes        # Enable rotary encoder (+90)
OLED_DRIVER_ENABLE = yes    # Enable the OLED Driver (+5000)
IOS_DEVICE_ENABLE = no      # Limit max brightness to connect to IOS device (iPad,iPhone)


```
## Compile

go to qmk top directory.
```
$ cd qmk_firmware
```

build
```
$ make rgbkb/zygomorph:default
```

After the initial flash with AVRdudess, you should be able to flash using this:
```
$ make rgbkb/zygomorph:default:dfu
```