diff options
Diffstat (limited to 'keyboards/dark/magnum_ergo_1/readme.md')
| -rw-r--r-- | keyboards/dark/magnum_ergo_1/readme.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/keyboards/dark/magnum_ergo_1/readme.md b/keyboards/dark/magnum_ergo_1/readme.md new file mode 100644 index 0000000000..c6a5d23b56 --- /dev/null +++ b/keyboards/dark/magnum_ergo_1/readme.md @@ -0,0 +1,28 @@ +# Gondolindrim X Dark Magnum Ergo 1 PCB QMK firmware + +The Magnum Ergo 1 is an Alice-layout ergonomic keyboard designed by Dark, with a PCB designer by Gondolindrim. + +* Keyboard Maintainer: [Gondolindrim](https://github.com/Gondolindrim) +* Hardware Supported: proprietary PCB using STM32F4x1C microcontroller; +* Availability: as of november 2022 both keyboard and PCB were sold in a private Group Buy; therefore availability is limited. + +## How to flash + +### Enter bootloader + +The DFU state in the bootloader can be accessed in 3 ways: + +* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key, grave accent in the default keymap) and plug in the keyboard; +* **Physical reset button**: press the button on the front of the PCB, next to caps lock, for at least five seconds; +* **Keycode in layout**: Press the key mapped to `QK_BOOT`; in the default layout, that is top left key ('grave') in layer 1. + +### How to compile and flash + +You can compile the Iron 165R2 default keymap by using the following: + + make magnum_ergo_1:default + +And use dfu-util in the command line or through a GUI like QMK toolbox to upload the firmware to the PCB. To directly flash the PCB after it is put into a DFU state, use: + + make magnum_ergo_1:default:flash + |