qmk_firmware/keyboards/ergodash/readme.md

# ErgoDash

![ErgoDash](https://github.com/omkbd/picture/blob/master/Ergodash.jpg)

Keyboard Maintainer: [omkbd](https://github.com/omkbd) [@omkbd](https://twitter.com/omkbd)  
Hardware Supported: ErgoDash PCB, Pro Micro ATmega32u4  
Hardware Availability: Order your own [yourself](https://github.com/omkbd/ErgoDash)


Make example for this keyboard (after setting up your build environment):

    make ergodash/rev1:default

See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.

Install Example: (for pro micro)
    `make ergodash/rev1:default:avrdude`

Note:  
  "rev1" is for PCB ver 1.0,1.1,1.2  
  **The original Rev 1 was owned only by the designer. Therefore, Rev1 has been removed. Since the current PCB is Rev1, we changed Rev2 to Rev1 to match the firmware version.**


# Layout
![layout](https://github.com/omkbd/picture/blob/master/ergodash-layout.png)

Layout Note:  
- In thumb cluster, it is not possible to use all 5 positions as small keys. (as pictured)
- The top 2 1u keys in the thumb cluster share the same connection.
- 2u key (center) position shares with the lower 1u key position

![PCB](https://github.com/omkbd/picture/blob/master/Ergodash_PCB.jpg)
Add ErgoDash keyboard (#3128) * create ergodash * Revert "create ergodash" This reverts commit b261c808c30fee95cb656629f7e9b44b01e79363. * add ergodash * keymap→layout * use set_single_persistent_default_layer 2018-06-06 16:41:51 +00:00			`# ErgoDash`

Keyboard: add ergodash mini keyboard (#3901) * add ergodash mini add ergodash mini (4rows version) fix keymap and readme * fix replace include guard remove includes * fix audio 2018-09-15 17:57:46 +00:00			`![ErgoDash](https://github.com/omkbd/picture/blob/master/Ergodash.jpg)`
Add ErgoDash keyboard (#3128) * create ergodash * Revert "create ergodash" This reverts commit b261c808c30fee95cb656629f7e9b44b01e79363. * add ergodash * keymap→layout * use set_single_persistent_default_layer 2018-06-06 16:41:51 +00:00
			`Keyboard Maintainer: [omkbd](https://github.com/omkbd) [@omkbd](https://twitter.com/omkbd)`
			`Hardware Supported: ErgoDash PCB, Pro Micro ATmega32u4`
ErgoDash Hardware Update (#3269) * Hardware update Backlight enable Change pin Add 2keys (68→70) * change readme * support rev1 change keymap path * move ergodash.h 2018-06-30 20:13:34 +00:00			`Hardware Availability: Order your own [yourself](https://github.com/omkbd/ErgoDash)`

Add ErgoDash keyboard (#3128) * create ergodash * Revert "create ergodash" This reverts commit b261c808c30fee95cb656629f7e9b44b01e79363. * add ergodash * keymap→layout * use set_single_persistent_default_layer 2018-06-06 16:41:51 +00:00
			`Make example for this keyboard (after setting up your build environment):`

[Keybooard] Update of Ergodash Keyboard (#5772) * Simpler coding use SPLIT_KEYBOARD delete rev1 (rev2→rev1) because rev1is not sold * delete USE_I2C = no * Update readme.md 2019-05-05 23:19:07 +00:00			`make ergodash/rev1:default`
Add ErgoDash keyboard (#3128) * create ergodash * Revert "create ergodash" This reverts commit b261c808c30fee95cb656629f7e9b44b01e79363. * add ergodash * keymap→layout * use set_single_persistent_default_layer 2018-06-06 16:41:51 +00:00
			`See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.`
ErgoDash Hardware Update (#3269) * Hardware update Backlight enable Change pin Add 2keys (68→70) * change readme * support rev1 change keymap path * move ergodash.h 2018-06-30 20:13:34 +00:00
ergodash Keyboard readme documentation (#5046) * Update readme.md Added reminder/example on how to install * Update readme.md Added note about rev2 and PCB versions * Update readme.md format 2019-02-04 00:59:39 +00:00			`Install Example: (for pro micro)`
[Keybooard] Update of Ergodash Keyboard (#5772) * Simpler coding use SPLIT_KEYBOARD delete rev1 (rev2→rev1) because rev1is not sold * delete USE_I2C = no * Update readme.md 2019-05-05 23:19:07 +00:00			`make ergodash/rev1:default:avrdude`

ergodash Keyboard readme documentation (#5046) * Update readme.md Added reminder/example on how to install * Update readme.md Added note about rev2 and PCB versions * Update readme.md format 2019-02-04 00:59:39 +00:00			`Note:`
[Keybooard] Update of Ergodash Keyboard (#5772) * Simpler coding use SPLIT_KEYBOARD delete rev1 (rev2→rev1) because rev1is not sold * delete USE_I2C = no * Update readme.md 2019-05-05 23:19:07 +00:00			`"rev1" is for PCB ver 1.0,1.1,1.2`
			`The original Rev 1 was owned only by the designer. Therefore, Rev1 has been removed. Since the current PCB is Rev1, we changed Rev2 to Rev1 to match the firmware version.`

ergodash Keyboard readme documentation (#5046) * Update readme.md Added reminder/example on how to install * Update readme.md Added note about rev2 and PCB versions * Update readme.md format 2019-02-04 00:59:39 +00:00
ErgoDash Hardware Update (#3269) * Hardware update Backlight enable Change pin Add 2keys (68→70) * change readme * support rev1 change keymap path * move ergodash.h 2018-06-30 20:13:34 +00:00			`# Layout`
			`![layout](https://github.com/omkbd/picture/blob/master/ergodash-layout.png)`
[Keyboard] Update ergodash readme.md (#5092) Clarification of Keys to Keymap note added 2019-02-10 20:50:55 +00:00
			`Layout Note:`
			`- In thumb cluster, it is not possible to use all 5 positions as small keys. (as pictured)`
			`- The top 2 1u keys in the thumb cluster share the same connection.`
			`- 2u key (center) position shares with the lower 1u key position`

Keyboard: add ergodash mini keyboard (#3901) * add ergodash mini add ergodash mini (4rows version) fix keymap and readme * fix replace include guard remove includes * fix audio 2018-09-15 17:57:46 +00:00			`![PCB](https://github.com/omkbd/picture/blob/master/Ergodash_PCB.jpg)`