aboutsummaryrefslogtreecommitdiff
path: root/keyboards/minidox/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/minidox/readme.md')
-rw-r--r--keyboards/minidox/readme.md66
1 files changed, 9 insertions, 57 deletions
diff --git a/keyboards/minidox/readme.md b/keyboards/minidox/readme.md
index 74afedc18..ec52e1f75 100644
--- a/keyboards/minidox/readme.md
+++ b/keyboards/minidox/readme.md
@@ -1,75 +1,27 @@
1MiniDox 1# MiniDox
2=====
3 2
4![MiniDox](http://i.imgur.com/iWb3yO0.jpg) 3![MiniDox](http://i.imgur.com/iWb3yO0.jpg)
5 4
6A compact version of the ErgoDox 5A compact version of the ErgoDox
7 6
8Keyboard Maintainer: That-Canadian 7* Keyboard Maintainer: That-Canadian
9Hardware Supported: MiniDox PCB rev1 Pro Micro 8* Hardware Supported: MiniDox PCB rev1 Pro Micro
10 9
11Make example for this keyboard (after setting up your build environment): 10Make example for this keyboard (after setting up your build environment):
12 11
13 make minidox/rev1:default 12 make minidox/rev1:default
14 13
14Flashing example for this keyboard ([using the command line](https://docs.qmk.fm/#/newbs_flashing?id=flash-your-keyboard-from-the-command-line)):
15
16 make minidox/rev1:default:flash
17
15See [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. 18See [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.
16 19
17## Build Guide 20## Build Guide
18 21
19A build guide for putting together the MiniDox v1 can be found here: [MiniDox Build Log / Guide](http://imgur.com/a/vImo6) 22A build guide for putting together the MiniDox v1 can be found here: [MiniDox Build Log / Guide](http://imgur.com/a/vImo6)
20 23
21Flashing
22-------
23Note: Most of this is copied from the Let's Split readme, because it is awesome
24
25From the root directory run `make PROJECT:KEYMAP:avrdude` for automatic serial port resolution and flashing.
26Example: `make minidox/rev1:default:avrdude`
27
28Choosing which board to plug the USB cable into (choosing Master)
29--------
30Because the two boards are identical, the firmware has logic to differentiate the left and right board.
31
32It uses two strategies to figure things out: look at the EEPROM (memory on the chip) or looks if the current board has the usb cable.
33
34The EEPROM approach requires additional setup (flashing the eeeprom) but allows you to swap the usb cable to either side.
35
36The USB cable approach is easier to setup and if you just want the usb cable on the left board, you do not need to do anything extra.
37
38### Setting the left hand as master
39If you always plug the usb cable into the left board, nothing extra is needed as this is the default. Comment out `EE_HANDS` and comment out `I2C_MASTER_RIGHT` or `MASTER_RIGHT` if for some reason it was set.
40
41### Setting the right hand as master
42If you always plug the usb cable into the right board, add an extra flag to your `config.h`
43```
44 #define MASTER_RIGHT
45```
46
47### Setting EE_hands to use either hands as master
48If you define `EE_HANDS` in your `config.h`, you will need to set the
49EEPROM for the left and right halves.
50
51The EEPROM is used to store whether the
52half is left handed or right handed. This makes it so that the same firmware
53file will run on both hands instead of having to flash left and right handed
54versions of the firmware to each half. To flash the EEPROM file for the left
55half run:
56```
57avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:"./quantum/split_common/eeprom-lefthand.eep"
58// or the equivalent in dfu-programmer
59
60```
61and similarly for right half
62```
63avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:"./quantum/split_common/eeprom-righthand.eep"
64// or the equivalent in dfu-programmer
65```
66
67NOTE: replace `$(COM_PORT)` with the port of your device (e.g. `/dev/ttyACM0`)
68 24
69After you have flashed the EEPROM, you then need to set `EE_HANDS` in your config.h, rebuild the hex files and reflash. 25## Choosing which board to plug the USB cable into (choosing Master)
70 26
71Note that you need to program both halves, but you have the option of using 27Because 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.
72different keymaps for each half. You could program the left half with a QWERTY
73layout and the right half with a Colemak layout using bootmagic's default layout option.
74Then if you connect the left half to a computer by USB the keyboard will use QWERTY and Colemak when the
75right half is connected.