summaryrefslogtreecommitdiff
path: root/keyboards/zinc/keymaps/default/readme_en.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/zinc/keymaps/default/readme_en.md')
-rw-r--r--keyboards/zinc/keymaps/default/readme_en.md131
1 files changed, 0 insertions, 131 deletions
diff --git a/keyboards/zinc/keymaps/default/readme_en.md b/keyboards/zinc/keymaps/default/readme_en.md
deleted file mode 100644
index 3be6b29616..0000000000
--- a/keyboards/zinc/keymaps/default/readme_en.md
+++ /dev/null
@@ -1,131 +0,0 @@
-# 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)
-```