summaryrefslogtreecommitdiff
path: root/keyboards/ergodox/readme.md
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2017-08-23 22:29:07 -0400
committerGitHub <noreply@github.com>2017-08-23 22:29:07 -0400
commitd2ff66a985b938e87fffe55c1d9f1dc55e356f91 (patch)
tree561b3e203033849573a17f5ac6248077ab687676 /keyboards/ergodox/readme.md
parent7260fc3eef98fb7b0e2ed24d3d0d14cf2e613000 (diff)
Creates a layouts/ folder for keymaps shared between keyboards (#1609)
* include variables and .h files as pp directives * start layout compilation * split ergodoxes up * don't compile all layouts for everything * might seg fault * reset layouts variable * actually reset layouts * include rules.mk instead * remove includes from rules.mk * update variable setting * load visualizer from path * adds some more examples * adds more layouts * more boards added * more boards added * adds documentation for layouts * use lowercase names for LAYOUT_ * add layout.json files for each layout * add community folder, default keymaps for layouts * touch-up default layouts * touch-up layouts, some keyboard rules.mk * update documentation for layouts * fix up serial/i2c switches
Diffstat (limited to 'keyboards/ergodox/readme.md')
-rw-r--r--keyboards/ergodox/readme.md111
1 files changed, 0 insertions, 111 deletions
diff --git a/keyboards/ergodox/readme.md b/keyboards/ergodox/readme.md
deleted file mode 100644
index 3a87606cd0..0000000000
--- a/keyboards/ergodox/readme.md
+++ /dev/null
@@ -1,111 +0,0 @@
-ErgoDox
-==
-
-The ErgoDox is a split ergonomic keyboard originally developed by Dominic "Dox" Beauchamp.
-
-* The **ErgoDox EZ** is a Teensy-based split mechanical keyboard, sold assembled and with warranty at [ErgoDox-EZ.com](https://ergodox-ez.com).
-* The **ErgoDox Infinity** is an ARM-based split mechanical keyboard, sold from time to time in kit form at [MassDrop.com](https://www.massdrop.com/buy/infinity-ergodox)
-
-The ErgoDox EZ code is maintained by Erez Zukerman and is officially supported by the EZ -- the keyboard ships running QMK from the factory.
-
-The ErgoDox Infinity code is maintained by Fredizzimo, as a community contribution.
-
-## Standard Build Instructions
-
-To build QMK for the ErgoDox, see the official [build guide](/docs/build_guide.md).
-
-## Additional resources
-
-A graphical configurator for the ErgoDox EZ is available at [configure.ergodox-ez.com](http://configure.ergodox-ez.com). It outputs QMK-compiled binaries, as well as source code for your layout, which you can use as a jumping-off point to further customize in QMK.
-
-# Flashing Firmware
-
-## ErgoDox EZ
-
-The Ez uses the [Teensy Loader](https://www.pjrc.com/teensy/loader.html).
-
-Linux users need to modify udev rules as described on the [Teensy
-Linux page]. Some distributions provide a binary, maybe called
-`teensy-loader-cli`.
-
-[Teensy Linux page]: https://www.pjrc.com/teensy/loader_linux.html
-
-To flash the firmware:
-
- - Build the firmware with `make keymapname`, for example `make default`
- - This will result in a hex file called `ergodox_ez_keymapname.hex`, e.g.
- `ergodox_ez_default.hex`
-
- - Start the teensy loader.
-
- - Load the .hex file into it.
-
- - Press the Reset button by inserting a paperclip gently into the reset hole
- in the top right corder.
-
- - Click the button in the Teensy app to download the firmware.
-
-To flash with ´teensy-loader-cli´:
-
- - Build the firmware with `make keymapname`, for example `make default`
-
- - Run ´<path/to/>teensy_loader_cli -mmcu=atmega32u4 -w ergodox_ez_<keymap>.hex´
-
- - Press the Reset button by inserting a paperclip gently into the reset hole
- in the top right corder.
-
-## ErgoDox Infinity
-
-The Infinity is two completely independent keyboards, and needs to be flashed
-for the left and right halves seperately. To flash them:
-
- - Build the firmware with `make infinity-keymapname`
-
- - Plug in the left hand keyboard only.
-
- - Press the program button (back of keyboard, above thumb pad).
-
- - Install the firmware with `sudo make infinity-keymapname-dfu-util`
-
- - Build right hand firmware with `make infinity-keymapname MASTER=right`
-
- - Plug in the right hand keyboard only.
-
- - Press the program button (back of keyboard, above thumb pad).
-
- - Install the firmware with `sudo make infinity-keymapname-dfu-util MASTER=right`
-
-More information on the Infinity firmware is available in the [TMK/chibios for
-Input Club Infinity Ergodox](https://github.com/fredizzimo/infinity_ergodox/blob/master/README.md)
-
-### Infinity Master/Two Halves
-
-The Infinity is two completely independent keyboards, that can connect together.
-You have a few options in how you flash the firmware:
-
-- Flash the left half, rebuild the firmware with "MASTER=right" and then flash
- the right half. This allows you to plug in either half directly to the
- computer and is what the above instructions do.
-
-- Flash the left half, then flash the same firmware on the right. This only
- works when the left half is plugged directly to the computer and the keymap
- is mirrored. It saves the small extra step of rebuilding with
- "MASTER=right".
-
-- The same as the previous one but with "MASTER=right" when you build the
- firmware, then flash the same firmware to both halves. You just have to
- directly connect the right half to the computer.
-
-- For minor changes such as changing only the keymap without having updated
- any part of the firmware code itself, you can program only the MASTER half.
- It is safest to program both halves though.
-
-## ErgoDone
-
-The ErgoDone uses its own HID bootloader and needs to be flashed using the [TKG Toolkit](https://github.com/kairyu/tkg-toolkit).
-
- - Build the firmware with `make ergodone-keymapname`
-
- - While plugging in the USB cable, hold the two right-most keys on the left half of the ErgoDone to enter FLASH mode.
-
- - Use the utility from [TKG Toolkit](https://github.com/kairyu/tkg-toolkit) to flash the keyboard: `hid_bootloader_cli -mmcu=atmega32u4 ergodox_ergodone_keymapname.hex`