1
0
Fork 0
forked from forks/qmk_firmware
qmk_firmware/keyboards/zinc/keymaps/default/readme_en.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

132 lines
6.6 KiB
Markdown

# The Default Zinc Layout
## layout
### Qwerty
```
,-----------------------------------------. ,-----------------------------------------.
| Tab | Q | W | E | R | T | | Y | U | I | O | P | Bksp |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| Ctrl | A | S | D | F | G | | H | J | K | L | ; | ' |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| Shift| Z | X | C | V | B | | N | M | , | . | / |Enter |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| Esc | Fn | Alt | Win |Lower |Space | | Space| Raise| Left | Down | Up | Right|
`------------------------------------------ ------------------------------------------'
```
### Colemak
```
,-----------------------------------------. ,-----------------------------------------.
| Tab | Q | W | F | P | G | | J | L | U | Y | ; | Bksp |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| Ctrl | A | R | S | T | D | | H | N | E | I | O | ' |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| Shift| Z | X | C | V | B | | K | M | , | . | / |Enter |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| Esc |ADJUST| Alt | Win |LOWER |Space | | Space| RAISE| Left | Down | Up | Right|
`------------------------------------------ ------------------------------------------'
```
### Dvorak
```
,-----------------------------------------. ,-----------------------------------------.
| Tab | ' | , | . | P | Y | | F | G | C | R | L | Del |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| Ctrl | A | O | E | U | I | | D | H | T | N | S | / |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| Shift| ; | Q | J | K | X | | B | M | W | V | Z |Enter |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| Esc |ADJUST| Alt | Win |LOWER |Space | | Space| RAISE| Left | Down | Up | Right|
`-----------------------------------------' `-----------------------------------------'
```
### Lower
```
,-----------------------------------------. ,-----------------------------------------.
| ~ | ! | @ | # | $ | % | | ^ | & | * | ( | ) | |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| | | | | | | | - | _ | + | { | } | | |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| | | | | | | | | | | Home | End | |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| | | | | | | | | | Next | Vol- | Vol+ | Play |
`-----------------------------------------' `-----------------------------------------'
```
### RAISE
```
,-----------------------------------------. ,-----------------------------------------.
| ` | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | Del |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| | F1 | F2 | F3 | F4 | F5 | | F6 | - | = | [ | ] | \ |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| | F7 | F8 | F9 | F10 | F11 | | F12 | | | | |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| | | | | | | | | | Next | Vol- | Vol+ | Play |
`-----------------------------------------' `-----------------------------------------'
```
### Adjust (Lower + Raise)
```
,-----------------------------------------. ,-----------------------------------------.
| | Reset|RGBRST|Aud on|Audoff| | | |Qwerty|Colemk|Dvorak| | Ins |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| |RGB ON| HUE+ | SAT+ | VAL+ | Mac | | Win | - | = |Print |ScLock|Pause |
|------+------+------+------+------+------| |------+------+------+------+------+------|
|MODE R|RGBMOD| HUE- | SAT- | VAL- | | | | | | |PageUp| |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| | | | EISU | EISU | EISU | | KANA | KANA | KANA | Home |PageDn| End |
`-----------------------------------------' `-----------------------------------------'
```
## Compile
go to qmk top directory.
```
$ cd qmk_firmware
```
make with `zinc:<keymap_name>`
```
$ make zinc:default
```
To make and flash with `:flash`
```
$ make zinc:default:flash
```
## Customize
You can customize from the command line.
```
# Zinc keyboard 'default' keymap: convenient command line option
make ZINC=<options> zinc:defualt
# option= back | under | both | cont | na | ios
# ex.
# make ZINC=under zinc:defualt
# make ZINC=under,ios zinc:defualt
# make ZINC=back zinc:default
# make ZINC=back,na zinc:default
# make ZINC=back,ios zinc:default
```
Or edit `qmk_firmware/keyboards/zinc/rev1/keymaps/~/rules.mk` directly.
```
# Zinc keyboard customize
LED_BACK_ENABLE = no # LED backlight (Enable SK6812mini backlight)
LED_UNDERGLOW_ENABLE = no # LED underglow (Enable WS2812 RGB underlight)
LED_BOTH_ENABLE = no # LED backlight and underglow
LED_RGB_CONT = no # LED continuous backlight or/and underglow between left Zinc and right Zinc
LED_ANIMATIONS = yes # LED animations
IOS_DEVICE_ENABLE = no # connect to IOS device (iPad,iPhone)
```