1 files changed, 121 insertions, 0 deletions
diff --git a/keyboards/rgbkb/zygomorph/keymaps/default/readme.md b/keyboards/rgbkb/zygomorph/keymaps/default/readme.md
new file mode 100644
index 000000000..e1d30b36b
--- /dev/null
+++ b/keyboards/rgbkb/zygomorph/keymaps/default/readme.md
@@ -0,0 +1,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
+```

diff --git a/keyboards/rgbkb/zygomorph/keymaps/default/readme.md b/keyboards/rgbkb/zygomorph/keymaps/default/readme.md new file mode 100644 index 000000000..e1d30b36b --- /dev/null +++ b/keyboards/rgbkb/zygomorph/keymaps/default/readme.md
@@ -0,0 +1,121 @@
	1	# The Default Zygomorph Layout
	2	## Layout
	3
	4	### Base modifier layout
	5	```
	6	* ,-----------------------------------------. ,-----------------------------------------.
	7	* \| GESC \| \| \| \| \| \| \| \| \| \| \| \| BkSp \|
	8	* \|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	9	* \| Tab \| \| \| \| \| \| \| \| \| \| \| \| \ \|
	10	* \|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	11	* \|FN(CAPS)\| \| \| \| \| \| \| \| \| \| \| \| ' \|
	12	* \|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	13	* \|Shift \| \| \| \| \| \| \| \| \| \| \| \|Shift \|
	14	* \|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	15	* \| Ctrl \| Win \| Alt \| RGB \| ADJ \| Space\| \| Space\| FN \| Left \| Down \| Up \|Right \|
	16	* `-----------------------------------------' `-----------------------------------------'
	17	```
	18
	19	### Qwerty alphas
	20	```
	21	* ,-----------------------------------------. ,-----------------------------------------.
	22	* \| \| \| \| \| \| \| \| \| \| \| \| \| \|
	23	* \|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	24	* \| \| Q \| W \| E \| R \| T \| \| Y \| U \| I \| O \| P \| \|
	25	* \|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	26	* \| \| A \| S \| D \| F \| G \| \| H \| J \| K \| L \| ; \| \|
	27	* \|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	28	* \| \| Z \| X \| C \| V \| B \| \| N \| M \| , \| . \| / \| \|
	29	* \|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	30	* \| \| \| \| \| \| \| \| \| \| \| \| \| \|
	31	* `-----------------------------------------' `-----------------------------------------'
	32	```
	33
	34	### Colemak alphas
	35	```
	36	* ,-----------------------------------------. ,-----------------------------------------.
	37	* \| \| \| \| \| \| \| \| \| \| \| \| \| \|
	38	* \|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	39	* \| \| Q \| W \| F \| P \| G \| \| J \| L \| U \| Y \| ; \| \|
	40	* \|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	41	* \| \| A \| R \| S \| T \| D \| \| H \| N \| E \| I \| O \| \|
	42	* \|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	43	* \| \| Z \| X \| C \| V \| B \| \| K \| M \| , \| . \| / \| \|
	44	* \|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	45	* \| \| \| \| \| \| \| \| \| \| \| \| \| \|
	46	* `-----------------------------------------' `-----------------------------------------'
	47	```
	48
	49	### Function (FN)
	50	```
	51	* ,-----------------------------------------. ,-----------------------------------------.
	52	* \| F1 \| F2 \| F3 \| F4 \| F5 \| F6 \| \| F7 \| F8 \| F9 \| F10 \| F11 \| F12 \|
	53	* \|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	54	* \| \| PGDN \| UP \| PGUP \| \| \| \| \| PGDN \| UP \| PGUP \| PRINT\| HOME \|
	55	* \|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	56	* \| \| LEFT \| DOWN \| RIGHT\| \| \| \| \| LEFT \| DOWN \| RIGHT\|INSERT\| END \|
	57	* \|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	58	* \| \| \| \| \| \| \| \| \| \| \| \| \| \|
	59	* \|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	60	* \| \| \| \|RGBMOD\| \| \| \| \| PLAY \| NEXT \| MUTE \| VOL- \| VOL+ \|
	61	* `-----------------------------------------' `-----------------------------------------'
	62	```
	63
	64	### Adjust (ADJ)
	65	```
	66	* ,-----------------------------------------. ,-----------------------------------------.
	67	* \| F1 \| F2 \| F3 \| F4 \| F5 \| F6 \| \| F7 \| F8 \| F9 \| F10 \| F11 \| F12 \|
	68	* \|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	69	* \| \| SAD \| VAI \| SAI \| RESET\| \| \| \| \| \| \| \| \|
	70	* \|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	71	* \| \| HUD \| VAD \| HUI \|RGBRST\| \| \| \|QWERTY\|COLEMK\| \| \| \|
	72	* \|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	73	* \| \| \| \| \| \| \| \| \| \|RGBTOG\| HUI \| SAI \| VAI \|
	74	* \|------+------+------+------+------+------\| \|------+------+------+------+------+------\|
	75	* \| \| \| \|RGBMOD\| \| \| \| \| \|RGBRMOD\| HUD \| SAD \| VAD \|
	76	* `-----------------------------------------' `-----------------------------------------'
	77	```
	78
	79	## Customize
	80
	81	see `qmk_firmware/keyboards/zygomorph/rev1/keymaps/default/rules.mk`
	82
	83	```
	84
	85	# Variables you can set for Zygomorph
	86
	87	BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration(+1000)
	88	MOUSEKEY_ENABLE = no # Mouse keys(+4700)
	89	EXTRAKEY_ENABLE = yes # Audio control and System control(+450)
	90	CONSOLE_ENABLE = yes # Console for debug(+400)
	91	COMMAND_ENABLE = no # Commands for debug and configuration
	92	NKRO_ENABLE = no # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
	93	RGBLIGHT_ENABLE = yes # Enable global lighting effects. Do not enable with RGB Matrix
	94	RGBLIGHT_ANIMATIONS = yes # LED animations
	95	RGB_MATRIX_ENABLE = no # Enable per-key coordinate based RGB effects. Do not enable with RGBlight (+8500)
	96	RGB_MATRIX_KEYPRESSES = no # Enable reactive per-key effects. Can be very laggy (+1500)
	97	RGBLIGHT_FULL_POWER = yes # Allow maximum RGB brightness. Otherwise, limited to a safe level for a normal USB-A port
	98	UNICODE_ENABLE = no # Unicode
	99	SWAP_HANDS_ENABLE = no # Enable one-hand typing
	100	ENCODER_ENABLE = yes # Enable rotary encoder (+90)
	101	OLED_DRIVER_ENABLE = yes # Enable the OLED Driver (+5000)
	102	IOS_DEVICE_ENABLE = no # Limit max brightness to connect to IOS device (iPad,iPhone)
	103
	104
	105	```
	106	## Compile
	107
	108	go to qmk top directory.
	109	```
	110	$ cd qmk_firmware
	111	```
	112
	113	build
	114	```
	115	$ make rgbkb/zygomorph:default
	116	```
	117
	118	After the initial flash with AVRdudess, you should be able to flash using this:
	119	```
	120	$ make rgbkb/zygomorph:default:dfu
	121	```