keychron_qmk_firmware/keyboards/minidox/readme.md

# MiniDox

![MiniDox](http://i.imgur.com/iWb3yO0.jpg)

A compact version of the ErgoDox

* Keyboard Maintainer: That-Canadian
* Hardware Supported: MiniDox PCB rev1 Pro Micro

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

    make minidox/rev1:default

Flashing example for this keyboard ([using the command line](https://docs.qmk.fm/#/newbs_flashing?id=flash-your-keyboard-from-the-command-line)):

    make minidox/rev1:default:flash

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.

## Build Guide

A build guide for putting together the MiniDox v1 can be found here: [MiniDox Build Log / Guide](http://imgur.com/a/vImo6)


## Choosing which board to plug the USB cable into (choosing Master)

Because the two boards are identical, the firmware has logic to differentiate the left and right board. It uses two strategies to figure things out, [EE_HANDS](https://docs.qmk.fm/#/feature_split_keyboard?id=handedness-by-eeprom) or [by define](https://docs.qmk.fm/#/feature_split_keyboard?id=handedness-by-define). See [setting-handedness](https://docs.qmk.fm/#/config_options?id=setting-handedness) for more information.
Refactor minidox to use split_common (#7924) * Initial refactor of minidox to split_common * post rebase fixes 2020-01-30 04:33:15 +06:00			`# MiniDox`
Adds Minidox Keyboard (#1487) * merge * line ending stuff * Added MiniDox keyboard folder / configs / and some keymaps * Updated minidox rev1 config, and readme. Also updated that_canadian keymap to include RGB * cleaned up that_canadian keymap comments * Fixed RGB being enabled by default, now it must be turned on at the keymap level 2017-07-11 06:15:08 +06:00
Fix location of where the make command should be run 2017-08-04 00:33:55 +06:00			`![MiniDox](http://i.imgur.com/iWb3yO0.jpg)`
Adds Minidox Keyboard (#1487) * merge * line ending stuff * Added MiniDox keyboard folder / configs / and some keymaps * Updated minidox rev1 config, and readme. Also updated that_canadian keymap to include RGB * cleaned up that_canadian keymap comments * Fixed RGB being enabled by default, now it must be turned on at the keymap level 2017-07-11 06:15:08 +06:00
			`A compact version of the ErgoDox`

Refactor minidox to use split_common (#7924) * Initial refactor of minidox to split_common * post rebase fixes 2020-01-30 04:33:15 +06:00			`* Keyboard Maintainer: That-Canadian`
			`* Hardware Supported: MiniDox PCB rev1 Pro Micro`
Adds Minidox Keyboard (#1487) * merge * line ending stuff * Added MiniDox keyboard folder / configs / and some keymaps * Updated minidox rev1 config, and readme. Also updated that_canadian keymap to include RGB * cleaned up that_canadian keymap comments * Fixed RGB being enabled by default, now it must be turned on at the keymap level 2017-07-11 06:15:08 +06:00
			`Make example for this keyboard (after setting up your build environment):`

Make arguments redo, subproject elimination (#1784) * redo make args to use colons, better folder structuring system [skip ci] * don't put spaces after statements - hard lessons in makefile development * fix-up some other rules.mk * give travis a chance * reset KEYMAPS variable * start converting keyboards to new system * try making all with travis * redo make args to use colons, better folder structuring system [skip ci] * don't put spaces after statements - hard lessons in makefile development * fix-up some other rules.mk * give travis a chance * reset KEYMAPS variable * start converting keyboards to new system * try making all with travis * start to update readmes and keyboards * look in keyboard directories for board.mk * update visualizer rules * fix up some other keyboards/keymaps * fix arm board ld includes * fix board rules * fix up remaining keyboards * reset layout variable * reset keyboard_layouts * fix remainging keymaps/boards * update readmes, docs * add note to makefile error * update readmes * remove planck keymap warnings * update references and docs * test out tarvis build stages * don't use stages for now * don't use stages for now 2017-10-15 03:32:19 +06:00			`make minidox/rev1:default`
Adds Minidox Keyboard (#1487) * merge * line ending stuff * Added MiniDox keyboard folder / configs / and some keymaps * Updated minidox rev1 config, and readme. Also updated that_canadian keymap to include RGB * cleaned up that_canadian keymap comments * Fixed RGB being enabled by default, now it must be turned on at the keymap level 2017-07-11 06:15:08 +06:00
Refactor minidox to use split_common (#7924) * Initial refactor of minidox to split_common * post rebase fixes 2020-01-30 04:33:15 +06:00			`Flashing example for this keyboard ([using the command line](https://docs.qmk.fm/#/newbs_flashing?id=flash-your-keyboard-from-the-command-line)):`

			`make minidox/rev1:default:flash`

Modified URLs to point to new locations 2019-01-13 06:51:21 +06: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.`
Updated MiniDox readme 2017-07-15 07:57:41 +06:00
			`## Build Guide`

			`A build guide for putting together the MiniDox v1 can be found here: [MiniDox Build Log / Guide](http://imgur.com/a/vImo6)`


Refactor minidox to use split_common (#7924) * Initial refactor of minidox to split_common * post rebase fixes 2020-01-30 04:33:15 +06:00			`## Choosing which board to plug the USB cable into (choosing Master)`
Updated MiniDox readme 2017-07-15 07:57:41 +06:00
Refactor minidox to use split_common (#7924) * Initial refactor of minidox to split_common * post rebase fixes 2020-01-30 04:33:15 +06:00			`Because the two boards are identical, the firmware has logic to differentiate the left and right board. It uses two strategies to figure things out, [EE_HANDS](https://docs.qmk.fm/#/feature_split_keyboard?id=handedness-by-eeprom) or [by define](https://docs.qmk.fm/#/feature_split_keyboard?id=handedness-by-define). See [setting-handedness](https://docs.qmk.fm/#/config_options?id=setting-handedness) for more information.`