1 files changed, 131 insertions, 0 deletions
diff --git a/keyboards/zinc/keymaps/default/readme_en.md b/keyboards/zinc/keymaps/default/readme_en.md
new file mode 100644
index 000000000..6447e96ed
--- /dev/null
+++ b/keyboards/zinc/keymaps/default/readme_en.md
@@ -0,0 +1,131 @@
+# 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)
+```

diff --git a/keyboards/zinc/keymaps/default/readme_en.md b/keyboards/zinc/keymaps/default/readme_en.md new file mode 100644 index 000000000..6447e96ed --- /dev/null +++ b/keyboards/zinc/keymaps/default/readme_en.md
@@ -0,0 +1,131 @@
	1	# The Default Zinc Layout
	2	## layout
	3
	4	### Qwerty
	5
	6	```
	7	,-----------------------------------------. ,-----------------------------------------.
	8	\| Tab \| Q \| W \| E \| R \| T \| \| Y \| U \| I \| O \| P \| Bksp \|
	9	\|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	10	\| Ctrl \| A \| S \| D \| F \| G \| \| H \| J \| K \| L \| ; \| ' \|
	11	\|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	12	\| Shift\| Z \| X \| C \| V \| B \| \| N \| M \| , \| . \| / \|Enter \|
	13	\|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	14	\| Esc \| Fn \| Alt \| Win \|Lower \|Space \| \| Space\| Raise\| Left \| Down \| Up \| Right\|
	15	`------------------------------------------ ------------------------------------------'
	16	```
	17
	18	### Colemak
	19
	20	```
	21	,-----------------------------------------. ,-----------------------------------------.
	22	\| Tab \| Q \| W \| F \| P \| G \| \| J \| L \| U \| Y \| ; \| Bksp \|
	23	\|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	24	\| Ctrl \| A \| R \| S \| T \| D \| \| H \| N \| E \| I \| O \| ' \|
	25	\|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	26	\| Shift\| Z \| X \| C \| V \| B \| \| K \| M \| , \| . \| / \|Enter \|
	27	\|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	28	\| Esc \|ADJUST\| Alt \| Win \|LOWER \|Space \| \| Space\| RAISE\| Left \| Down \| Up \| Right\|
	29	`------------------------------------------ ------------------------------------------'
	30	```
	31
	32	### Dvorak
	33
	34	```
	35	,-----------------------------------------. ,-----------------------------------------.
	36	\| Tab \| ' \| , \| . \| P \| Y \| \| F \| G \| C \| R \| L \| Del \|
	37	\|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	38	\| Ctrl \| A \| O \| E \| U \| I \| \| D \| H \| T \| N \| S \| / \|
	39	\|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	40	\| Shift\| ; \| Q \| J \| K \| X \| \| B \| M \| W \| V \| Z \|Enter \|
	41	\|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	42	\| Esc \|ADJUST\| Alt \| Win \|LOWER \|Space \| \| Space\| RAISE\| Left \| Down \| Up \| Right\|
	43	`-----------------------------------------' `-----------------------------------------'
	44	```
	45
	46	### Lower
	47	```
	48	,-----------------------------------------. ,-----------------------------------------.
	49	\| ~ \| ! \| @ \| # \| $ \| % \| \| ^ \| & \| * \| ( \| ) \| \|
	50	\|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	51	\| \| \| \| \| \| \| \| - \| _ \| + \| { \| } \| \| \|
	52	\|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	53	\| \| \| \| \| \| \| \| \| \| \| Home \| End \| \|
	54	\|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	55	\| \| \| \| \| \| \| \| \| \| Next \| Vol- \| Vol+ \| Play \|
	56	`-----------------------------------------' `-----------------------------------------'
	57	```
	58
	59	### RAISE
	60	```
	61	,-----------------------------------------. ,-----------------------------------------.
	62	\| ` \| 1 \| 2 \| 3 \| 4 \| 5 \| \| 6 \| 7 \| 8 \| 9 \| 0 \| Del \|
	63	\|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	64	\| \| F1 \| F2 \| F3 \| F4 \| F5 \| \| F6 \| - \| = \| [ \| ] \| \ \|
	65	\|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	66	\| \| F7 \| F8 \| F9 \| F10 \| F11 \| \| F12 \| \| \| \| \|
	67	\|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	68	\| \| \| \| \| \| \| \| \| \| Next \| Vol- \| Vol+ \| Play \|
	69	`-----------------------------------------' `-----------------------------------------'
	70	```
	71
	72	### Adjust (Lower + Raise)
	73	```
	74	,-----------------------------------------. ,-----------------------------------------.
	75	\| \| Reset\|RGBRST\|Aud on\|Audoff\| \| \| \|Qwerty\|Colemk\|Dvorak\| \| Ins \|
	76	\|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	77	\| \|RGB ON\| HUE+ \| SAT+ \| VAL+ \| Mac \| \| Win \| - \| = \|Print \|ScLock\|Pause \|
	78	\|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	79	\|MODE R\|RGBMOD\| HUE- \| SAT- \| VAL- \| \| \| \| \| \| \|PageUp\| \|
	80	\|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	81	\| \| \| \| EISU \| EISU \| EISU \| \| KANA \| KANA \| KANA \| Home \|PageDn\| End \|
	82	`-----------------------------------------' `-----------------------------------------'
	83	```
	84
	85	## Compile
	86
	87	go to qmk top directory.
	88
	89	```
	90	$ cd qmk_firmware
	91	```
	92	make with `zinc:<keymap_name>`
	93
	94	```
	95	$ make zinc:default
	96	```
	97
	98	To make and flash with `:flash`
	99
	100	```
	101	$ make zinc:default:flash
	102	```
	103
	104
	105	## Customize
	106
	107	You can customize from the command line.
	108
	109	```
	110	# Zinc keyboard 'default' keymap: convenient command line option
	111	make ZINC=<options> zinc:defualt
	112	# option= back \| under \| both \| cont \| na \| ios
	113	# ex.
	114	# make ZINC=under zinc:defualt
	115	# make ZINC=under,ios zinc:defualt
	116	# make ZINC=back zinc:default
	117	# make ZINC=back,na zinc:default
	118	# make ZINC=back,ios zinc:default
	119	```
	120
	121	Or edit `qmk_firmware/keyboards/zinc/rev1/keymaps/~/rules.mk` directly.
	122
	123	```
	124	# Zinc keyboard customize
	125	LED_BACK_ENABLE = no # LED backlight (Enable SK6812mini backlight)
	126	LED_UNDERGLOW_ENABLE = no # LED underglow (Enable WS2812 RGB underlight)
	127	LED_BOTH_ENABLE = no # LED backlight and underglow
	128	LED_RGB_CONT = no # LED continuous backlight or/and underglow between left Zinc and right Zinc
	129	LED_ANIMATIONS = yes # LED animations
	130	IOS_DEVICE_ENABLE = no # connect to IOS device (iPad,iPhone)
	131	```